Class: Aws::Drs::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-drs/client.rb,
sig/client.rbs

Overview

An API client for Drs. To construct a client, you need to configure a :region and :credentials.

client = Aws::Drs::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Defined Under Namespace

Modules: _AssociateSourceNetworkStackResponseSuccess, _CancelRecoveryPlanExecutionResponseSuccess, _CreateExtendedSourceServerResponseSuccess, _CreateLaunchConfigurationTemplateResponseSuccess, _CreateRecoveryPlanResponseSuccess, _CreateRecoveryPlanStepResponseSuccess, _CreateReplicationConfigurationTemplateResponseSuccess, _CreateSourceNetworkResponseSuccess, _DeleteJobResponseSuccess, _DeleteLaunchActionResponseSuccess, _DeleteLaunchConfigurationTemplateResponseSuccess, _DeleteRecoveryPlanExecutionResponseSuccess, _DeleteRecoveryPlanResponseSuccess, _DeleteRecoveryPlanStepResponseSuccess, _DeleteReplicationConfigurationTemplateResponseSuccess, _DeleteSourceNetworkResponseSuccess, _DeleteSourceServerResponseSuccess, _DescribeJobLogItemsResponseSuccess, _DescribeJobsResponseSuccess, _DescribeLaunchConfigurationTemplatesResponseSuccess, _DescribeRecoveryInstancesResponseSuccess, _DescribeRecoverySnapshotsResponseSuccess, _DescribeReplicationConfigurationTemplatesResponseSuccess, _DescribeSourceNetworksResponseSuccess, _DescribeSourceServersResponseSuccess, _DisconnectSourceServerResponseSuccess, _ExportSourceNetworkCfnTemplateResponseSuccess, _GetFailbackReplicationConfigurationResponseSuccess, _GetLaunchConfigurationResponseSuccess, _GetRecoveryPlanExecutionResponseSuccess, _GetRecoveryPlanExecutionStepResponseSuccess, _GetRecoveryPlanResponseSuccess, _GetRecoveryPlanStepResponseSuccess, _GetReplicationConfigurationResponseSuccess, _InitializeServiceResponseSuccess, _ListExtensibleSourceServersResponseSuccess, _ListLaunchActionsResponseSuccess, _ListRecoveryPlanExecutionStepsResponseSuccess, _ListRecoveryPlanExecutionsResponseSuccess, _ListRecoveryPlanStepsResponseSuccess, _ListRecoveryPlansResponseSuccess, _ListStagingAccountsResponseSuccess, _ListTagsForResourceResponseSuccess, _PutLaunchActionResponseSuccess, _ReorderRecoveryPlanStepsResponseSuccess, _RetryDataReplicationResponseSuccess, _RetryRecoveryPlanExecutionStepResponseSuccess, _ReverseReplicationResponseSuccess, _StartFailbackLaunchResponseSuccess, _StartRecoveryPlanExecutionResponseSuccess, _StartRecoveryResponseSuccess, _StartReplicationResponseSuccess, _StartSourceNetworkRecoveryResponseSuccess, _StartSourceNetworkReplicationResponseSuccess, _StopReplicationResponseSuccess, _StopSourceNetworkReplicationResponseSuccess, _TerminateRecoveryInstancesResponseSuccess, _UpdateLaunchConfigurationResponseSuccess, _UpdateLaunchConfigurationTemplateResponseSuccess, _UpdateRecoveryPlanExecutionStepResponseSuccess, _UpdateRecoveryPlanResponseSuccess, _UpdateRecoveryPlanStepResponseSuccess, _UpdateReplicationConfigurationResponseSuccess, _UpdateReplicationConfigurationTemplateResponseSuccess

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Drs::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Drs::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-drs/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4577
4578
4579
 
# File 'lib/aws-sdk-drs/client.rb', line 4577

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4580
4581
4582
 
# File 'lib/aws-sdk-drs/client.rb', line 4580

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Drs/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#associate_source_network_stack(params = {}) ⇒ Types::AssociateSourceNetworkStackResponse

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

Examples:

Request syntax with placeholder values


resp = client.associate_source_network_stack({
  source_network_id: "SourceNetworkID", # required
  cfn_stack_name: "CfnStackName", # required
})

Response structure


resp.job.job_id #=> String
resp.job.arn #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.job.initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].source_server_id #=> String
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.job.participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    The Source Network ID to associate with CloudFormation template.

  • :cfn_stack_name (required, String) —

    CloudFormation template to associate with a Source Network.

Returns:

See Also:



86
 
# File 'sig/client.rbs', line 86

def associate_source_network_stack: (

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
 
# File 'lib/aws-sdk-drs/client.rb', line 4550

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Drs')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-drs'
  context[:gem_version] = '1.72.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_recovery_plan_execution(params = {}) ⇒ Types::CancelRecoveryPlanExecutionResponse

Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.

Examples:

Request syntax with placeholder values


resp = client.cancel_recovery_plan_execution({
  recovery_plan_execution_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_execution.recovery_plan_execution_arn #=> String
resp.recovery_plan_execution.recovery_plan_arn #=> String
resp.recovery_plan_execution.mode #=> String, one of "DRILL", "RECOVERY"
resp.recovery_plan_execution.status #=> String, one of "CREATED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.recovery_plan_execution.started_at #=> String
resp.recovery_plan_execution.completed_at #=> String
resp.recovery_plan_execution.error_detail.message #=> String
resp.recovery_plan_execution.error_detail.code #=> String
resp.recovery_plan_execution.tags #=> Hash
resp.recovery_plan_execution.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_arn (required, String) —

    The ARN of the Recovery Plan execution to cancel.

Returns:

See Also:



97
 
# File 'sig/client.rbs', line 97

def cancel_recovery_plan_execution: (

#create_extended_source_server(params = {}) ⇒ Types::CreateExtendedSourceServerResponse

Create an extended source server in the target Account based on the source server in staging account.

Examples:

Request syntax with placeholder values


resp = client.create_extended_source_server({
  source_server_arn: "SourceServerARN", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.source_server.source_server_id #=> String
resp.source_server.arn #=> String
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
resp.source_server.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.source_server.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.steps #=> Array
resp.source_server.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.source_server.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_error.raw_error #=> String
resp.source_server.data_replication_info.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.first_byte_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.job_id #=> String
resp.source_server.life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.source_server.life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.source_server.source_properties.last_updated_date_time #=> String
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.identification_hints.fqdn #=> String
resp.source_server.source_properties.identification_hints.hostname #=> String
resp.source_server.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> String
resp.source_server.source_properties.network_interfaces #=> Array
resp.source_server.source_properties.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.network_interfaces[0].ips #=> Array
resp.source_server.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_server.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_server.source_properties.disks #=> Array
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.cpus #=> Array
resp.source_server.source_properties.cpus[0].cores #=> Integer
resp.source_server.source_properties.cpus[0].model_name #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_network_id #=> String
resp.source_server.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_arn (required, String) —

    This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

  • :tags (Hash<String,String>) —

    A list of tags associated with the extended source server.

Returns:

See Also:



107
 
# File 'sig/client.rbs', line 107

def create_extended_source_server: (

#create_launch_configuration_template(params = {}) ⇒ Types::CreateLaunchConfigurationTemplateResponse

Creates a new Launch Configuration Template.

Examples:

Request syntax with placeholder values


resp = client.create_launch_configuration_template({
  tags: {
    "TagKey" => "TagValue",
  },
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC, IN_AWS
  copy_private_ip: false,
  copy_tags: false,
  licensing: {
    os_byol: false,
  },
  export_bucket_arn: "ARN",
  post_launch_enabled: false,
  launch_into_source_instance: false,
  recovery_mode: "FAST", # accepts FAST, OPTIMAL
})

Response structure


resp.launch_configuration_template.launch_configuration_template_id #=> String
resp.launch_configuration_template.arn #=> String
resp.launch_configuration_template.tags #=> Hash
resp.launch_configuration_template.tags["TagKey"] #=> String
resp.launch_configuration_template.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.launch_configuration_template.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
resp.launch_configuration_template.copy_private_ip #=> Boolean
resp.launch_configuration_template.copy_tags #=> Boolean
resp.launch_configuration_template.licensing.os_byol #=> Boolean
resp.launch_configuration_template.export_bucket_arn #=> String
resp.launch_configuration_template.post_launch_enabled #=> Boolean
resp.launch_configuration_template.launch_into_source_instance #=> Boolean
resp.launch_configuration_template.recovery_mode #=> String, one of "FAST", "OPTIMAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (Hash<String,String>) —

    Request to associate tags during creation of a Launch Configuration Template.

  • :launch_disposition (String) —

    Launch disposition.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :licensing (Types::Licensing) —

    Licensing.

  • :export_bucket_arn (String) —

    S3 bucket ARN to export Source Network templates.

  • :post_launch_enabled (Boolean) —

    Whether we want to activate post-launch actions.

  • :launch_into_source_instance (Boolean) —

    DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

  • :recovery_mode (String) —

    Recovery mode.

Returns:

See Also:



118
 
# File 'sig/client.rbs', line 118

def create_launch_configuration_template: (

#create_recovery_plan(params = {}) ⇒ Types::CreateRecoveryPlanResponse

Creates a Recovery Plan to orchestrate multi-server disaster recovery.

Examples:

Request syntax with placeholder values


resp = client.create_recovery_plan({
  name: "RecoveryPlanName", # required
  description: "RecoveryPlanDescription",
  client_token: "ClientIdempotencyToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.recovery_plan.recovery_plan_arn #=> String
resp.recovery_plan.name #=> String
resp.recovery_plan.description #=> String
resp.recovery_plan.status #=> String, one of "ACTIVE", "INVALID"
resp.recovery_plan.created_at #=> String
resp.recovery_plan.updated_at #=> String
resp.recovery_plan.tags #=> Hash
resp.recovery_plan.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of a Recovery Plan.

  • :description (String) —

    The description of a Recovery Plan.

  • :client_token (String) —

    A unique string provided to ensure request idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags to apply to the Recovery Plan.

Returns:

See Also:



139
 
# File 'sig/client.rbs', line 139

def create_recovery_plan: (

#create_recovery_plan_step(params = {}) ⇒ Types::CreateRecoveryPlanStepResponse

Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).

Examples:

Request syntax with placeholder values


resp = client.create_recovery_plan_step({
  recovery_plan_arn: "StrictDRSARN", # required
  step_name: "RecoveryPlanStepName", # required
  step_order: 1,
  configuration: { # required
    server_step_configuration: {
      servers: [ # required
        {
          server_arn: "SourceServerARN", # required
          impact_level: "CRITICAL", # accepts CRITICAL, OPTIONAL
        },
      ],
    },
    wait_step_configuration: {
      wait_duration_minutes: 1, # required
    },
  },
  client_token: "ClientIdempotencyToken",
})

Response structure


resp.recovery_plan_step.recovery_plan_step_arn #=> String
resp.recovery_plan_step.step_order #=> Integer
resp.recovery_plan_step.step_name #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers #=> Array
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_step.created_at #=> String
resp.recovery_plan_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan to add the step to.

  • :step_name (required, String) —

    The name of a Recovery Plan Step.

  • :step_order (Integer) —

    The order of a step within a Recovery Plan (1-based).

  • :configuration (required, Types::RecoveryPlanStepConfiguration) —

    Type-specific configuration for a recovery plan step. Exactly one member must be set.

  • :client_token (String) —

    A unique string provided to ensure request idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



152
 
# File 'sig/client.rbs', line 152

def create_recovery_plan_step: (

#create_replication_configuration_template(params = {}) ⇒ Types::ReplicationConfigurationTemplate

Creates a new ReplicationConfigurationTemplate.

Examples:

Request syntax with placeholder values


resp = client.create_replication_configuration_template({
  staging_area_subnet_id: "SubnetID", # required
  associate_default_security_group: false,
  replication_servers_security_groups_i_ds: ["SecurityGroupID"], # required
  replication_server_instance_type: "EC2InstanceType",
  use_dedicated_replication_server: false,
  default_large_staging_disk_type: "GP2", # accepts GP2, GP3, ST1, AUTO
  ebs_encryption: "DEFAULT", # required, accepts DEFAULT, CUSTOM, NONE
  ebs_encryption_key_arn: "ARN",
  bandwidth_throttling: 1, # required
  data_plane_routing: "PRIVATE_IP", # accepts PRIVATE_IP, PUBLIC_IP
  create_public_ip: false,
  staging_area_tags: { # required
    "TagKey" => "TagValue",
  },
  pit_policy: [ # required
    {
      rule_id: 1,
      units: "MINUTE", # required, accepts MINUTE, HOUR, DAY
      interval: 1, # required
      retention_duration: 1, # required
      enabled: false,
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  auto_replicate_new_disks: false,
  internet_protocol: "IPV4", # accepts IPV4, IPV6
})

Response structure


resp.replication_configuration_template_id #=> String
resp.arn #=> String
resp.staging_area_subnet_id #=> String
resp.associate_default_security_group #=> Boolean
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.replication_server_instance_type #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.ebs_encryption_key_arn #=> String
resp.bandwidth_throttling #=> Integer
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.create_public_ip #=> Boolean
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].enabled #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.internet_protocol #=> String, one of "IPV4", "IPV6"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :staging_area_subnet_id (required, String) —

    The subnet to be used by the replication staging area.

  • :associate_default_security_group (Boolean) —

    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

  • :replication_servers_security_groups_i_ds (required, Array<String>) —

    The security group IDs that will be used by the replication server.

  • :replication_server_instance_type (String) —

    The instance type to be used for the replication server.

  • :use_dedicated_replication_server (Boolean) —

    Whether to use a dedicated Replication Server in the replication staging area.

  • :default_large_staging_disk_type (String) —

    The Staging Disk EBS volume type to be used during replication.

  • :ebs_encryption (required, String) —

    The type of EBS encryption to be used during replication.

  • :ebs_encryption_key_arn (String) —

    The ARN of the EBS encryption key to be used during replication.

  • :bandwidth_throttling (required, Integer) —

    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

  • :data_plane_routing (String) —

    The data plane routing mechanism that will be used for replication.

  • :create_public_ip (Boolean) —

    Whether to create a Public IP for the Recovery Instance by default.

  • :staging_area_tags (required, Hash<String,String>) —

    A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

  • :pit_policy (required, Array<Types::PITPolicyRule>) —

    The Point in time (PIT) policy to manage snapshots taken during replication.

  • :tags (Hash<String,String>) —

    A set of tags to be associated with the Replication Configuration Template resource.

  • :auto_replicate_new_disks (Boolean) —

    Whether to allow the AWS replication agent to automatically replicate newly added disks.

  • :internet_protocol (String) —

    Which version of the Internet Protocol to use for replication of data. (IPv4 or IPv6)

Returns:

See Also:



183
 
# File 'sig/client.rbs', line 183

def create_replication_configuration_template: (

#create_source_network(params = {}) ⇒ Types::CreateSourceNetworkResponse

Create a new Source Network resource for a provided VPC ID.

Examples:

Request syntax with placeholder values


resp = client.create_source_network({
  vpc_id: "VpcID", # required
  origin_account_id: "AccountID", # required
  origin_region: "AwsRegion", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.source_network_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    Which VPC ID to protect.

  • :origin_account_id (required, String) —

    Account containing the VPC to protect.

  • :origin_region (required, String) —

    Region containing the VPC to protect.

  • :tags (Hash<String,String>) —

    A set of tags to be associated with the Source Network resource.

Returns:

See Also:



216
 
# File 'sig/client.rbs', line 216

def create_source_network: (

#delete_job(params = {}) ⇒ Struct

Deletes a single Job by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_job({
  job_id: "JobID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the Job to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



228
 
# File 'sig/client.rbs', line 228

def delete_job: (

#delete_launch_action(params = {}) ⇒ Struct

Deletes a resource launch action.

Examples:

Request syntax with placeholder values


resp = client.delete_launch_action({
  resource_id: "LaunchActionResourceId", # required
  action_id: "LaunchActionId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

  • :action_id (required, String) —

    Launch action Id.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



237
 
# File 'sig/client.rbs', line 237

def delete_launch_action: (

#delete_launch_configuration_template(params = {}) ⇒ Struct

Deletes a single Launch Configuration Template by ID.

Examples:

Request syntax with placeholder values


resp = client.delete_launch_configuration_template({
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_template_id (required, String) —

    The ID of the Launch Configuration Template to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



247
 
# File 'sig/client.rbs', line 247

def delete_launch_configuration_template: (

#delete_recovery_instance(params = {}) ⇒ Struct

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

Examples:

Request syntax with placeholder values


resp = client.delete_recovery_instance({
  recovery_instance_id: "RecoveryInstanceID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



253
 
# File 'sig/client.rbs', line 253

def delete_recovery_instance: (

#delete_recovery_plan(params = {}) ⇒ Types::DeleteRecoveryPlanResponse

Deletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status (CREATED, IN_PROGRESS).

Examples:

Request syntax with placeholder values


resp = client.delete_recovery_plan({
  recovery_plan_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan to delete.

Returns:

See Also:



263
 
# File 'sig/client.rbs', line 263

def delete_recovery_plan: (

#delete_recovery_plan_execution(params = {}) ⇒ Types::DeleteRecoveryPlanExecutionResponse

Deletes a Recovery Plan execution record. Must be in a terminal status.

Examples:

Request syntax with placeholder values


resp = client.delete_recovery_plan_execution({
  recovery_plan_execution_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_execution_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_arn (required, String) —

    The ARN of the Recovery Plan execution to delete.

Returns:

See Also:



273
 
# File 'sig/client.rbs', line 273

def delete_recovery_plan_execution: (

#delete_recovery_plan_step(params = {}) ⇒ Types::DeleteRecoveryPlanStepResponse

Deletes a step from a Recovery Plan.

Examples:

Request syntax with placeholder values


resp = client.delete_recovery_plan_step({
  recovery_plan_step_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_step_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_step_arn (required, String) —

    The ARN of the Recovery Plan step to delete.

Returns:

See Also:



283
 
# File 'sig/client.rbs', line 283

def delete_recovery_plan_step: (

#delete_replication_configuration_template(params = {}) ⇒ Struct

Deletes a single Replication Configuration Template by ID

Examples:

Request syntax with placeholder values


resp = client.delete_replication_configuration_template({
  replication_configuration_template_id: "ReplicationConfigurationTemplateID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replication_configuration_template_id (required, String) —

    The ID of the Replication Configuration Template to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



292
 
# File 'sig/client.rbs', line 292

def delete_replication_configuration_template: (

#delete_source_network(params = {}) ⇒ Struct

Delete Source Network resource.

Examples:

Request syntax with placeholder values


resp = client.delete_source_network({
  source_network_id: "SourceNetworkID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    ID of the Source Network to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



301
 
# File 'sig/client.rbs', line 301

def delete_source_network: (

#delete_source_server(params = {}) ⇒ Struct

Deletes a single Source Server by ID. The Source Server must be disconnected first.

Examples:

Request syntax with placeholder values


resp = client.delete_source_server({
  source_server_id: "SourceServerID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



310
 
# File 'sig/client.rbs', line 310

def delete_source_server: (

#describe_job_log_items(params = {}) ⇒ Types::DescribeJobLogItemsResponse

Retrieves a detailed Job log with pagination.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_job_log_items({
  job_id: "JobID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].log_date_time #=> String
resp.items[0].event #=> String, one of "JOB_START", "SERVER_SKIPPED", "CLEANUP_START", "CLEANUP_END", "CLEANUP_FAIL", "SNAPSHOT_START", "SNAPSHOT_END", "SNAPSHOT_FAIL", "USING_PREVIOUS_SNAPSHOT", "USING_PREVIOUS_SNAPSHOT_FAILED", "CONVERSION_START", "CONVERSION_END", "CONVERSION_FAIL", "LAUNCH_START", "LAUNCH_FAILED", "JOB_CANCEL", "JOB_END", "DEPLOY_NETWORK_CONFIGURATION_START", "DEPLOY_NETWORK_CONFIGURATION_END", "DEPLOY_NETWORK_CONFIGURATION_FAILED", "UPDATE_NETWORK_CONFIGURATION_START", "UPDATE_NETWORK_CONFIGURATION_END", "UPDATE_NETWORK_CONFIGURATION_FAILED", "UPDATE_LAUNCH_TEMPLATE_START", "UPDATE_LAUNCH_TEMPLATE_END", "UPDATE_LAUNCH_TEMPLATE_FAILED", "NETWORK_RECOVERY_FAIL"
resp.items[0].event_data.source_server_id #=> String
resp.items[0].event_data.conversion_server_id #=> String
resp.items[0].event_data.target_instance_id #=> String
resp.items[0].event_data.raw_error #=> String
resp.items[0].event_data.conversion_properties.volume_to_conversion_map #=> Hash
resp.items[0].event_data.conversion_properties.volume_to_conversion_map["LargeBoundedString"] #=> Hash
resp.items[0].event_data.conversion_properties.volume_to_conversion_map["LargeBoundedString"]["EbsSnapshot"] #=> String
resp.items[0].event_data.conversion_properties.root_volume_name #=> String
resp.items[0].event_data.conversion_properties.force_uefi #=> Boolean
resp.items[0].event_data.conversion_properties.data_timestamp #=> String
resp.items[0].event_data.conversion_properties.volume_to_volume_size #=> Hash
resp.items[0].event_data.conversion_properties.volume_to_volume_size["LargeBoundedString"] #=> Integer
resp.items[0].event_data.conversion_properties.volume_to_product_codes #=> Hash
resp.items[0].event_data.conversion_properties.volume_to_product_codes["LargeBoundedString"] #=> Array
resp.items[0].event_data.conversion_properties.volume_to_product_codes["LargeBoundedString"][0].product_code_id #=> String
resp.items[0].event_data.conversion_properties.volume_to_product_codes["LargeBoundedString"][0].product_code_mode #=> String, one of "ENABLED", "DISABLED"
resp.items[0].event_data.event_resource_data.source_network_data.source_network_id #=> String
resp.items[0].event_data.event_resource_data.source_network_data.source_vpc #=> String
resp.items[0].event_data.event_resource_data.source_network_data.target_vpc #=> String
resp.items[0].event_data.event_resource_data.source_network_data.stack_name #=> String
resp.items[0].event_data.attempt_count #=> Integer
resp.items[0].event_data.max_attempts_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the Job for which Job log items will be retrieved.

  • :max_results (Integer) —

    Maximum number of Job log items to retrieve.

  • :next_token (String) —

    The token of the next Job log items to retrieve.

Returns:

See Also:



321
 
# File 'sig/client.rbs', line 321

def describe_job_log_items: (

#describe_jobs(params = {}) ⇒ Types::DescribeJobsResponse

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_jobs({
  filters: {
    job_i_ds: ["JobID"],
    from_date: "ISO8601DatetimeString",
    to_date: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].job_id #=> String
resp.items[0].arn #=> String
resp.items[0].type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.items[0].initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.items[0].participating_servers #=> Array
resp.items[0].participating_servers[0].source_server_id #=> String
resp.items[0].participating_servers[0].recovery_instance_id #=> String
resp.items[0].participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs #=> Array
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].participating_resources #=> Array
resp.items[0].participating_resources[0].participating_resource_id.source_network_id #=> String
resp.items[0].participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Types::DescribeJobsRequestFilters) —

    A set of filters by which to return Jobs.

  • :max_results (Integer) —

    Maximum number of Jobs to retrieve.

  • :next_token (String) —

    The token of the next Job to retrieve.

Returns:

See Also:



334
 
# File 'sig/client.rbs', line 334

def describe_jobs: (

#describe_launch_configuration_templates(params = {}) ⇒ Types::DescribeLaunchConfigurationTemplatesResponse

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_launch_configuration_templates({
  launch_configuration_template_i_ds: ["LaunchConfigurationTemplateID"],
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].launch_configuration_template_id #=> String
resp.items[0].arn #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.items[0].target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
resp.items[0].copy_private_ip #=> Boolean
resp.items[0].copy_tags #=> Boolean
resp.items[0].licensing.os_byol #=> Boolean
resp.items[0].export_bucket_arn #=> String
resp.items[0].post_launch_enabled #=> Boolean
resp.items[0].launch_into_source_instance #=> Boolean
resp.items[0].recovery_mode #=> String, one of "FAST", "OPTIMAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_template_i_ds (Array<String>) —

    Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • :max_results (Integer) —

    Maximum results to be returned in DescribeLaunchConfigurationTemplates.

  • :next_token (String) —

    The token of the next Launch Configuration Template to retrieve.

Returns:

See Also:



351
 
# File 'sig/client.rbs', line 351

def describe_launch_configuration_templates: (

#describe_recovery_instances(params = {}) ⇒ Types::DescribeRecoveryInstancesResponse

Lists all Recovery Instances or multiple Recovery Instances by ID.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_recovery_instances({
  filters: {
    recovery_instance_i_ds: ["RecoveryInstanceID"],
    source_server_i_ds: ["SourceServerID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].ec2_instance_id #=> String
resp.items[0].ec2_instance_state #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED", "SHUTTING-DOWN", "TERMINATED", "NOT_FOUND"
resp.items[0].job_id #=> String
resp.items[0].recovery_instance_id #=> String
resp.items[0].source_server_id #=> String
resp.items[0].arn #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].failback.failback_client_id #=> String
resp.items[0].failback.failback_job_id #=> String
resp.items[0].failback.failback_initiation_time #=> String
resp.items[0].failback.state #=> String, one of "FAILBACK_NOT_STARTED", "FAILBACK_IN_PROGRESS", "FAILBACK_READY_FOR_LAUNCH", "FAILBACK_COMPLETED", "FAILBACK_ERROR", "FAILBACK_NOT_READY_FOR_LAUNCH", "FAILBACK_LAUNCH_STATE_NOT_AVAILABLE"
resp.items[0].failback.agent_last_seen_by_service_date_time #=> String
resp.items[0].failback.failback_client_last_seen_by_service_date_time #=> String
resp.items[0].failback.failback_to_original_server #=> Boolean
resp.items[0].failback.first_byte_date_time #=> String
resp.items[0].failback.elapsed_replication_duration #=> String
resp.items[0].failback.failback_launch_type #=> String, one of "RECOVERY", "DRILL"
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.eta_date_time #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
resp.items[0].data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED", "REPLICATION_STATE_NOT_AVAILABLE", "NOT_STARTED"
resp.items[0].data_replication_info.data_replication_initiation.start_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.steps #=> Array
resp.items[0].data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", "COMPLETE_VOLUME_MAPPING", "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", "CONFIGURE_REPLICATION_SOFTWARE", "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.items[0].data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "FAILBACK_CLIENT_NOT_SEEN", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", "FAILED_GETTING_REPLICATION_STATE", "SNAPSHOTS_FAILURE", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_error.raw_error #=> String
resp.items[0].data_replication_info.staging_availability_zone #=> String
resp.items[0].data_replication_info.staging_outpost_arn #=> String
resp.items[0].recovery_instance_properties.last_updated_date_time #=> String
resp.items[0].recovery_instance_properties.identification_hints.fqdn #=> String
resp.items[0].recovery_instance_properties.identification_hints.hostname #=> String
resp.items[0].recovery_instance_properties.identification_hints.vm_ware_uuid #=> String
resp.items[0].recovery_instance_properties.identification_hints.aws_instance_id #=> String
resp.items[0].recovery_instance_properties.network_interfaces #=> Array
resp.items[0].recovery_instance_properties.network_interfaces[0].mac_address #=> String
resp.items[0].recovery_instance_properties.network_interfaces[0].ips #=> Array
resp.items[0].recovery_instance_properties.network_interfaces[0].ips[0] #=> String
resp.items[0].recovery_instance_properties.network_interfaces[0].is_primary #=> Boolean
resp.items[0].recovery_instance_properties.disks #=> Array
resp.items[0].recovery_instance_properties.disks[0].internal_device_name #=> String
resp.items[0].recovery_instance_properties.disks[0].bytes #=> Integer
resp.items[0].recovery_instance_properties.disks[0].ebs_volume_id #=> String
resp.items[0].recovery_instance_properties.cpus #=> Array
resp.items[0].recovery_instance_properties.cpus[0].cores #=> Integer
resp.items[0].recovery_instance_properties.cpus[0].model_name #=> String
resp.items[0].recovery_instance_properties.ram_bytes #=> Integer
resp.items[0].recovery_instance_properties.os.full_string #=> String
resp.items[0].point_in_time_snapshot_date_time #=> String
resp.items[0].is_drill #=> Boolean
resp.items[0].origin_environment #=> String, one of "ON_PREMISES", "AWS"
resp.items[0].origin_availability_zone #=> String
resp.items[0].agent_version #=> String
resp.items[0].source_outpost_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Types::DescribeRecoveryInstancesRequestFilters) —

    A set of filters by which to return Recovery Instances.

  • :max_results (Integer) —

    Maximum number of Recovery Instances to retrieve.

  • :next_token (String) —

    The token of the next Recovery Instance to retrieve.

Returns:

See Also:



364
 
# File 'sig/client.rbs', line 364

def describe_recovery_instances: (

#describe_recovery_snapshots(params = {}) ⇒ Types::DescribeRecoverySnapshotsResponse

Lists all Recovery Snapshots for a single Source Server.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_recovery_snapshots({
  source_server_id: "SourceServerID", # required
  filters: {
    from_date_time: "ISO8601DatetimeString",
    to_date_time: "ISO8601DatetimeString",
  },
  order: "ASC", # accepts ASC, DESC
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].snapshot_id #=> String
resp.items[0].source_server_id #=> String
resp.items[0].expected_timestamp #=> String
resp.items[0].timestamp #=> String
resp.items[0].ebs_snapshots #=> Array
resp.items[0].ebs_snapshots[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    Filter Recovery Snapshots by Source Server ID.

  • :filters (Types::DescribeRecoverySnapshotsRequestFilters) —

    A set of filters by which to return Recovery Snapshots.

  • :order (String) —

    The sorted ordering by which to return Recovery Snapshots.

  • :max_results (Integer) —

    Maximum number of Recovery Snapshots to retrieve.

  • :next_token (String) —

    The token of the next Recovery Snapshot to retrieve.

Returns:

See Also:



380
 
# File 'sig/client.rbs', line 380

def describe_recovery_snapshots: (

#describe_replication_configuration_templates(params = {}) ⇒ Types::DescribeReplicationConfigurationTemplatesResponse

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_replication_configuration_templates({
  replication_configuration_template_i_ds: ["ReplicationConfigurationTemplateID"],
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].replication_configuration_template_id #=> String
resp.items[0].arn #=> String
resp.items[0].staging_area_subnet_id #=> String
resp.items[0].associate_default_security_group #=> Boolean
resp.items[0].replication_servers_security_groups_i_ds #=> Array
resp.items[0].replication_servers_security_groups_i_ds[0] #=> String
resp.items[0].replication_server_instance_type #=> String
resp.items[0].use_dedicated_replication_server #=> Boolean
resp.items[0].default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.items[0].ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.items[0].ebs_encryption_key_arn #=> String
resp.items[0].bandwidth_throttling #=> Integer
resp.items[0].data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.items[0].create_public_ip #=> Boolean
resp.items[0].staging_area_tags #=> Hash
resp.items[0].staging_area_tags["TagKey"] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].pit_policy #=> Array
resp.items[0].pit_policy[0].rule_id #=> Integer
resp.items[0].pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.items[0].pit_policy[0].interval #=> Integer
resp.items[0].pit_policy[0].retention_duration #=> Integer
resp.items[0].pit_policy[0].enabled #=> Boolean
resp.items[0].auto_replicate_new_disks #=> Boolean
resp.items[0].internet_protocol #=> String, one of "IPV4", "IPV6"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replication_configuration_template_i_ds (Array<String>) —

    The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

  • :max_results (Integer) —

    Maximum number of Replication Configuration Templates to retrieve.

  • :next_token (String) —

    The token of the next Replication Configuration Template to retrieve.

Returns:

See Also:



398
 
# File 'sig/client.rbs', line 398

def describe_replication_configuration_templates: (

#describe_source_networks(params = {}) ⇒ Types::DescribeSourceNetworksResponse

Lists all Source Networks or multiple Source Networks filtered by ID.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_source_networks({
  filters: {
    source_network_i_ds: ["SourceNetworkID"],
    origin_account_id: "AccountID",
    origin_region: "AwsRegion",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].source_network_id #=> String
resp.items[0].source_vpc_id #=> String
resp.items[0].arn #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.items[0].replication_status_details #=> String
resp.items[0].cfn_stack_name #=> String
resp.items[0].source_region #=> String
resp.items[0]. #=> String
resp.items[0].last_recovery.api_call_date_time #=> Time
resp.items[0].last_recovery.job_id #=> String
resp.items[0].last_recovery.last_recovery_result #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCESS", "FAIL", "PARTIAL_SUCCESS", "ASSOCIATE_SUCCESS", "ASSOCIATE_FAIL"
resp.items[0].launched_vpc_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Types::DescribeSourceNetworksRequestFilters) —

    A set of filters by which to return Source Networks.

  • :max_results (Integer) —

    Maximum number of Source Networks to retrieve.

  • :next_token (String) —

    The token of the next Source Networks to retrieve.

Returns:

See Also:



411
 
# File 'sig/client.rbs', line 411

def describe_source_networks: (

#describe_source_servers(params = {}) ⇒ Types::DescribeSourceServersResponse

Lists all Source Servers or multiple Source Servers filtered by ID.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_source_servers({
  filters: {
    source_server_i_ds: ["SourceServerID"],
    hardware_id: "BoundedString",
    staging_account_i_ds: ["AccountID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].source_server_id #=> String
resp.items[0].arn #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].recovery_instance_id #=> String
resp.items[0].last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.eta_date_time #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
resp.items[0].data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.items[0].data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.items[0].data_replication_info.data_replication_initiation.start_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.items[0].data_replication_info.data_replication_initiation.steps #=> Array
resp.items[0].data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.items[0].data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.items[0].data_replication_info.data_replication_error.raw_error #=> String
resp.items[0].data_replication_info.staging_availability_zone #=> String
resp.items[0].data_replication_info.staging_outpost_arn #=> String
resp.items[0].life_cycle.added_to_service_date_time #=> String
resp.items[0].life_cycle.first_byte_date_time #=> String
resp.items[0].life_cycle.elapsed_replication_duration #=> String
resp.items[0].life_cycle.last_seen_by_service_date_time #=> String
resp.items[0].life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_launch.initiated.job_id #=> String
resp.items[0].life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.items[0].life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].source_properties.last_updated_date_time #=> String
resp.items[0].source_properties.recommended_instance_type #=> String
resp.items[0].source_properties.identification_hints.fqdn #=> String
resp.items[0].source_properties.identification_hints.hostname #=> String
resp.items[0].source_properties.identification_hints.vm_ware_uuid #=> String
resp.items[0].source_properties.identification_hints.aws_instance_id #=> String
resp.items[0].source_properties.network_interfaces #=> Array
resp.items[0].source_properties.network_interfaces[0].mac_address #=> String
resp.items[0].source_properties.network_interfaces[0].ips #=> Array
resp.items[0].source_properties.network_interfaces[0].ips[0] #=> String
resp.items[0].source_properties.network_interfaces[0].is_primary #=> Boolean
resp.items[0].source_properties.disks #=> Array
resp.items[0].source_properties.disks[0].device_name #=> String
resp.items[0].source_properties.disks[0].bytes #=> Integer
resp.items[0].source_properties.cpus #=> Array
resp.items[0].source_properties.cpus[0].cores #=> Integer
resp.items[0].source_properties.cpus[0].model_name #=> String
resp.items[0].source_properties.ram_bytes #=> Integer
resp.items[0].source_properties.os.full_string #=> String
resp.items[0].source_properties.supports_nitro_instances #=> Boolean
resp.items[0].source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.items[0].staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.items[0].staging_area. #=> String
resp.items[0].staging_area.staging_source_server_arn #=> String
resp.items[0].staging_area.error_message #=> String
resp.items[0].source_cloud_properties. #=> String
resp.items[0].source_cloud_properties.origin_region #=> String
resp.items[0].source_cloud_properties.origin_availability_zone #=> String
resp.items[0].source_cloud_properties.source_outpost_arn #=> String
resp.items[0].replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.items[0].reversed_direction_source_server_arn #=> String
resp.items[0].source_network_id #=> String
resp.items[0].agent_version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Types::DescribeSourceServersRequestFilters) —

    A set of filters by which to return Source Servers.

  • :max_results (Integer) —

    Maximum number of Source Servers to retrieve.

  • :next_token (String) —

    The token of the next Source Server to retrieve.

Returns:

See Also:



428
 
# File 'sig/client.rbs', line 428

def describe_source_servers: (

#disconnect_recovery_instance(params = {}) ⇒ Struct

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Examples:

Request syntax with placeholder values


resp = client.disconnect_recovery_instance({
  recovery_instance_id: "RecoveryInstanceID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance to disconnect.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



440
 
# File 'sig/client.rbs', line 440

def disconnect_recovery_instance: (

#disconnect_source_server(params = {}) ⇒ Types::SourceServer

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Examples:

Request syntax with placeholder values


resp = client.disconnect_source_server({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server_id #=> String
resp.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.recovery_instance_id #=> String
resp.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.staging_availability_zone #=> String
resp.data_replication_info.staging_outpost_arn #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.life_cycle.last_launch.initiated.job_id #=> String
resp.life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.recommended_instance_type #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.os.full_string #=> String
resp.source_properties.supports_nitro_instances #=> Boolean
resp.source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.staging_area. #=> String
resp.staging_area.staging_source_server_arn #=> String
resp.staging_area.error_message #=> String
resp.source_cloud_properties. #=> String
resp.source_cloud_properties.origin_region #=> String
resp.source_cloud_properties.origin_availability_zone #=> String
resp.source_cloud_properties.source_outpost_arn #=> String
resp.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.reversed_direction_source_server_arn #=> String
resp.source_network_id #=> String
resp.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server to disconnect.

Returns:

See Also:



463
 
# File 'sig/client.rbs', line 463

def disconnect_source_server: (

#export_source_network_cfn_template(params = {}) ⇒ Types::ExportSourceNetworkCfnTemplateResponse

Export the Source Network CloudFormation template to an S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.export_source_network_cfn_template({
  source_network_id: "SourceNetworkID", # required
})

Response structure


resp.s3_destination_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    The Source Network ID to export its CloudFormation template to an S3 bucket.

Returns:

See Also:



473
 
# File 'sig/client.rbs', line 473

def export_source_network_cfn_template: (

#get_failback_replication_configuration(params = {}) ⇒ Types::GetFailbackReplicationConfigurationResponse

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

Examples:

Request syntax with placeholder values


resp = client.get_failback_replication_configuration({
  recovery_instance_id: "RecoveryInstanceID", # required
})

Response structure


resp.recovery_instance_id #=> String
resp.name #=> String
resp.bandwidth_throttling #=> Integer
resp.use_private_ip #=> Boolean
resp.internet_protocol #=> String, one of "IPV4", "IPV6"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance whose failback replication configuration should be returned.

Returns:

See Also:



487
 
# File 'sig/client.rbs', line 487

def get_failback_replication_configuration: (

#get_launch_configuration(params = {}) ⇒ Types::LaunchConfiguration

Gets a LaunchConfiguration, filtered by Source Server IDs.

Examples:

Request syntax with placeholder values


resp = client.get_launch_configuration({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server_id #=> String
resp.name #=> String
resp.ec2_launch_template_id #=> String
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.licensing.os_byol #=> Boolean
resp.post_launch_enabled #=> Boolean
resp.launch_into_instance_properties.launch_into_ec2_instance_id #=> String
resp.recovery_mode #=> String, one of "FAST", "OPTIMAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server that we want to retrieve a Launch Configuration for.

Returns:

See Also:



507
 
# File 'sig/client.rbs', line 507

def get_launch_configuration: (

#get_recovery_plan(params = {}) ⇒ Types::GetRecoveryPlanResponse

Gets a Recovery Plan by ARN.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_plan({
  recovery_plan_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan.recovery_plan_arn #=> String
resp.recovery_plan.name #=> String
resp.recovery_plan.description #=> String
resp.recovery_plan.status #=> String, one of "ACTIVE", "INVALID"
resp.recovery_plan.created_at #=> String
resp.recovery_plan.updated_at #=> String
resp.recovery_plan.tags #=> Hash
resp.recovery_plan.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan to retrieve.

Returns:

See Also:



517
 
# File 'sig/client.rbs', line 517

def get_recovery_plan: (

#get_recovery_plan_execution(params = {}) ⇒ Types::GetRecoveryPlanExecutionResponse

Gets the details of a Recovery Plan execution.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_plan_execution({
  recovery_plan_execution_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_execution.recovery_plan_execution_arn #=> String
resp.recovery_plan_execution.recovery_plan_arn #=> String
resp.recovery_plan_execution.mode #=> String, one of "DRILL", "RECOVERY"
resp.recovery_plan_execution.status #=> String, one of "CREATED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.recovery_plan_execution.started_at #=> String
resp.recovery_plan_execution.completed_at #=> String
resp.recovery_plan_execution.error_detail.message #=> String
resp.recovery_plan_execution.error_detail.code #=> String
resp.recovery_plan_execution.tags #=> Hash
resp.recovery_plan_execution.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_arn (required, String) —

    The ARN of the Recovery Plan execution.

Returns:

See Also:



527
 
# File 'sig/client.rbs', line 527

def get_recovery_plan_execution: (

#get_recovery_plan_execution_step(params = {}) ⇒ Types::GetRecoveryPlanExecutionStepResponse

Gets the details of a step within a Recovery Plan execution.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_plan_execution_step({
  recovery_plan_execution_step_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_execution_step.recovery_plan_execution_step_arn #=> String
resp.recovery_plan_execution_step.step_index #=> Integer
resp.recovery_plan_execution_step.status #=> String, one of "NOT_STARTED", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "TIMED_OUT", "SKIPPED"
resp.recovery_plan_execution_step.step_name #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers #=> Array
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].job_id #=> String
resp.recovery_plan_execution_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_execution_step.error_detail.message #=> String
resp.recovery_plan_execution_step.error_detail.code #=> String
resp.recovery_plan_execution_step.attempt #=> Integer
resp.recovery_plan_execution_step.created_at #=> String
resp.recovery_plan_execution_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_step_arn (required, String) —

    The ARN of the execution step.

Returns:

See Also:



537
 
# File 'sig/client.rbs', line 537

def get_recovery_plan_execution_step: (

#get_recovery_plan_step(params = {}) ⇒ Types::GetRecoveryPlanStepResponse

Gets a Recovery Plan step by ARN.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_plan_step({
  recovery_plan_step_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_step.recovery_plan_step_arn #=> String
resp.recovery_plan_step.step_order #=> Integer
resp.recovery_plan_step.step_name #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers #=> Array
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_step.created_at #=> String
resp.recovery_plan_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_step_arn (required, String) —

    The ARN of the Recovery Plan step to retrieve.

Returns:

See Also:



547
 
# File 'sig/client.rbs', line 547

def get_recovery_plan_step: (

#get_replication_configuration(params = {}) ⇒ Types::ReplicationConfiguration

Gets a ReplicationConfiguration, filtered by Source Server ID.

Examples:

Request syntax with placeholder values


resp = client.get_replication_configuration({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server_id #=> String
resp.name #=> String
resp.staging_area_subnet_id #=> String
resp.associate_default_security_group #=> Boolean
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.replication_server_instance_type #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].throughput #=> Integer
resp.replicated_disks[0].optimized_staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.ebs_encryption_key_arn #=> String
resp.bandwidth_throttling #=> Integer
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.create_public_ip #=> Boolean
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].enabled #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.internet_protocol #=> String, one of "IPV4", "IPV6"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Serve for this Replication Configuration.r

Returns:

See Also:



574
 
# File 'sig/client.rbs', line 574

def get_replication_configuration: (

#initialize_service(params = {}) ⇒ Struct

Initialize Elastic Disaster Recovery.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



583
 
# File 'sig/client.rbs', line 583

def initialize_service: (

#list_extensible_source_servers(params = {}) ⇒ Types::ListExtensibleSourceServersResponse

Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_extensible_source_servers({
  staging_account_id: "AccountID", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].hostname #=> String
resp.items[0].arn #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :staging_account_id (required, String) —

    The Id of the staging Account to retrieve extensible source servers from.

  • :max_results (Integer) —

    The maximum number of extensible source servers to retrieve.

  • :next_token (String) —

    The token of the next extensible source server to retrieve.

Returns:

See Also:



593
 
# File 'sig/client.rbs', line 593

def list_extensible_source_servers: (

#list_launch_actions(params = {}) ⇒ Types::ListLaunchActionsResponse

Lists resource launch actions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_launch_actions({
  resource_id: "LaunchActionResourceId", # required
  filters: {
    action_ids: ["LaunchActionId"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].action_id #=> String
resp.items[0].action_code #=> String
resp.items[0].type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.items[0].name #=> String
resp.items[0].active #=> Boolean
resp.items[0].order #=> Integer
resp.items[0].action_version #=> String
resp.items[0].optional #=> Boolean
resp.items[0].parameters #=> Hash
resp.items[0].parameters["LaunchActionParameterName"].value #=> String
resp.items[0].parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.items[0].description #=> String
resp.items[0].category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

  • :filters (Types::LaunchActionsRequestFilters) —

    Filters to apply when listing resource launch actions.

  • :max_results (Integer) —

    Maximum amount of items to return when listing resource launch actions.

  • :next_token (String) —

    Next token to use when listing resource launch actions.

Returns:

See Also:



606
 
# File 'sig/client.rbs', line 606

def list_launch_actions: (

#list_recovery_plan_execution_steps(params = {}) ⇒ Types::ListRecoveryPlanExecutionStepsResponse

Lists all steps within a Recovery Plan execution.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_plan_execution_steps({
  recovery_plan_execution_arn: "StrictDRSARN", # required
  filter: {
    status: "NOT_STARTED", # accepts NOT_STARTED, EXECUTING, WAITING, COMPLETED, FAILED, TIMED_OUT, SKIPPED
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.recovery_plan_execution_steps #=> Array
resp.recovery_plan_execution_steps[0].recovery_plan_execution_step_arn #=> String
resp.recovery_plan_execution_steps[0].step_name #=> String
resp.recovery_plan_execution_steps[0].step_index #=> Integer
resp.recovery_plan_execution_steps[0].status #=> String, one of "NOT_STARTED", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "TIMED_OUT", "SKIPPED"
resp.recovery_plan_execution_steps[0].configuration.execution_server_step_configuration.servers #=> Array
resp.recovery_plan_execution_steps[0].configuration.execution_server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_execution_steps[0].configuration.execution_server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_execution_steps[0].configuration.execution_server_step_configuration.servers[0].job_id #=> String
resp.recovery_plan_execution_steps[0].configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_execution_steps[0].error_detail.message #=> String
resp.recovery_plan_execution_steps[0].error_detail.code #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_arn (required, String) —

    The ARN of the Recovery Plan execution.

  • :filter (Types::ListRecoveryPlanExecutionStepsFilter) —

    Filters for listing execution steps.

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



622
 
# File 'sig/client.rbs', line 622

def list_recovery_plan_execution_steps: (

#list_recovery_plan_executions(params = {}) ⇒ Types::ListRecoveryPlanExecutionsResponse

Lists executions of Recovery Plans, optionally filtered by plan or status.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_plan_executions({
  recovery_plan_arn: "StrictDRSARN",
  status: "CREATED", # accepts CREATED, IN_PROGRESS, COMPLETED, FAILED, CANCELLING, CANCELLED
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.recovery_plan_executions #=> Array
resp.recovery_plan_executions[0].recovery_plan_execution_arn #=> String
resp.recovery_plan_executions[0].recovery_plan_arn #=> String
resp.recovery_plan_executions[0].mode #=> String, one of "DRILL", "RECOVERY"
resp.recovery_plan_executions[0].status #=> String, one of "CREATED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.recovery_plan_executions[0].started_at #=> String
resp.recovery_plan_executions[0].error_detail.message #=> String
resp.recovery_plan_executions[0].error_detail.code #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (String) —

    Filter executions by Recovery Plan ARN.

  • :status (String) —

    Filter executions by status.

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



638
 
# File 'sig/client.rbs', line 638

def list_recovery_plan_executions: (

#list_recovery_plan_steps(params = {}) ⇒ Types::ListRecoveryPlanStepsResponse

Lists all steps in a Recovery Plan.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_plan_steps({
  recovery_plan_arn: "StrictDRSARN", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.recovery_plan_steps #=> Array
resp.recovery_plan_steps[0].recovery_plan_step_arn #=> String
resp.recovery_plan_steps[0].step_order #=> Integer
resp.recovery_plan_steps[0].step_name #=> String
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers #=> Array
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_steps[0].configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_steps[0].created_at #=> String
resp.recovery_plan_steps[0].updated_at #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan.

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



652
 
# File 'sig/client.rbs', line 652

def list_recovery_plan_steps: (

#list_recovery_plans(params = {}) ⇒ Types::ListRecoveryPlansResponse

Lists all Recovery Plans in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_plans({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.recovery_plans #=> Array
resp.recovery_plans[0].recovery_plan_arn #=> String
resp.recovery_plans[0].name #=> String
resp.recovery_plans[0].status #=> String, one of "ACTIVE", "INVALID"
resp.recovery_plans[0].created_at #=> String
resp.recovery_plans[0].updated_at #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



665
 
# File 'sig/client.rbs', line 665

def list_recovery_plans: (

#list_staging_accounts(params = {}) ⇒ Types::ListStagingAccountsResponse

Returns an array of staging accounts for existing extended source servers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_staging_accounts({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.accounts #=> Array
resp.accounts[0]. #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of staging Accounts to retrieve.

  • :next_token (String) —

    The token of the next staging Account to retrieve.

Returns:

See Also:



677
 
# File 'sig/client.rbs', line 677

def list_staging_accounts: (

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List all tags for your Elastic Disaster Recovery resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ARN", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource whose tags should be returned.

Returns:

See Also:



688
 
# File 'sig/client.rbs', line 688

def list_tags_for_resource: (

#put_launch_action(params = {}) ⇒ Types::PutLaunchActionResponse

Puts a resource launch action.

Examples:

Request syntax with placeholder values


resp = client.put_launch_action({
  resource_id: "LaunchActionResourceId", # required
  action_code: "SsmDocumentName", # required
  order: 1, # required
  action_id: "LaunchActionId", # required
  optional: false, # required
  active: false, # required
  name: "LaunchActionName", # required
  action_version: "LaunchActionVersion", # required
  category: "MONITORING", # required, accepts MONITORING, VALIDATION, CONFIGURATION, SECURITY, OTHER
  parameters: {
    "LaunchActionParameterName" => {
      value: "LaunchActionParameterValue",
      type: "SSM_STORE", # accepts SSM_STORE, DYNAMIC
    },
  },
  description: "LaunchActionDescription", # required
})

Response structure


resp.resource_id #=> String
resp.action_id #=> String
resp.action_code #=> String
resp.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.name #=> String
resp.active #=> Boolean
resp.order #=> Integer
resp.action_version #=> String
resp.optional #=> Boolean
resp.parameters #=> Hash
resp.parameters["LaunchActionParameterName"].value #=> String
resp.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.description #=> String
resp.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

  • :action_code (required, String) —

    Launch action code.

  • :order (required, Integer) —

    Launch action order.

  • :action_id (required, String) —

    Launch action Id.

  • :optional (required, Boolean) —

    Whether the launch will not be marked as failed if this action fails.

  • :active (required, Boolean) —

    Whether the launch action is active.

  • :name (required, String) —

    Launch action name.

  • :action_version (required, String) —

    Launch action version.

  • :category (required, String) —

    Launch action category.

  • :parameters (Hash<String,Types::LaunchActionParameter>) —

    Launch action parameters.

  • :description (required, String) —

    Launch action description.

Returns:

See Also:



709
 
# File 'sig/client.rbs', line 709

def put_launch_action: (

#reorder_recovery_plan_steps(params = {}) ⇒ Types::ReorderRecoveryPlanStepsResponse

Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.

Examples:

Request syntax with placeholder values


resp = client.reorder_recovery_plan_steps({
  recovery_plan_arn: "StrictDRSARN", # required
  ordered_step_arns: ["StrictDRSARN"], # required
})

Response structure


resp.recovery_plan_steps #=> Array
resp.recovery_plan_steps[0].recovery_plan_step_arn #=> String
resp.recovery_plan_steps[0].step_order #=> Integer
resp.recovery_plan_steps[0].step_name #=> String
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers #=> Array
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_steps[0].configuration.server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_steps[0].configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_steps[0].created_at #=> String
resp.recovery_plan_steps[0].updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan.

  • :ordered_step_arns (required, Array<String>) —

    Ordered list of all step ARNs representing the desired sequence.

Returns:

See Also:



732
 
# File 'sig/client.rbs', line 732

def reorder_recovery_plan_steps: (

#retry_data_replication(params = {}) ⇒ Types::SourceServer

WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.

Examples:

Request syntax with placeholder values


resp = client.retry_data_replication({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server_id #=> String
resp.arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.recovery_instance_id #=> String
resp.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].device_name #=> String
resp.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.steps #=> Array
resp.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.data_replication_info.data_replication_error.raw_error #=> String
resp.data_replication_info.staging_availability_zone #=> String
resp.data_replication_info.staging_outpost_arn #=> String
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.first_byte_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.life_cycle.last_launch.initiated.job_id #=> String
resp.life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.source_properties.last_updated_date_time #=> String
resp.source_properties.recommended_instance_type #=> String
resp.source_properties.identification_hints.fqdn #=> String
resp.source_properties.identification_hints.hostname #=> String
resp.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_properties.identification_hints.aws_instance_id #=> String
resp.source_properties.network_interfaces #=> Array
resp.source_properties.network_interfaces[0].mac_address #=> String
resp.source_properties.network_interfaces[0].ips #=> Array
resp.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.os.full_string #=> String
resp.source_properties.supports_nitro_instances #=> Boolean
resp.source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.staging_area. #=> String
resp.staging_area.staging_source_server_arn #=> String
resp.staging_area.error_message #=> String
resp.source_cloud_properties. #=> String
resp.source_cloud_properties.origin_region #=> String
resp.source_cloud_properties.origin_availability_zone #=> String
resp.source_cloud_properties.source_outpost_arn #=> String
resp.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.reversed_direction_source_server_arn #=> String
resp.source_network_id #=> String
resp.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server whose data replication should be retried.

Returns:

See Also:



756
 
# File 'sig/client.rbs', line 756

def retry_data_replication: (

#retry_recovery_plan_execution_step(params = {}) ⇒ Types::RetryRecoveryPlanExecutionStepResponse

Retries a failed SERVER type execution step.

Examples:

Request syntax with placeholder values


resp = client.retry_recovery_plan_execution_step({
  recovery_plan_execution_step_arn: "StrictDRSARN", # required
})

Response structure


resp.recovery_plan_execution_step.recovery_plan_execution_step_arn #=> String
resp.recovery_plan_execution_step.step_index #=> Integer
resp.recovery_plan_execution_step.status #=> String, one of "NOT_STARTED", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "TIMED_OUT", "SKIPPED"
resp.recovery_plan_execution_step.step_name #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers #=> Array
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].job_id #=> String
resp.recovery_plan_execution_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_execution_step.error_detail.message #=> String
resp.recovery_plan_execution_step.error_detail.code #=> String
resp.recovery_plan_execution_step.attempt #=> Integer
resp.recovery_plan_execution_step.created_at #=> String
resp.recovery_plan_execution_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_step_arn (required, String) —

    The ARN of the execution step to retry.

Returns:

See Also:



766
 
# File 'sig/client.rbs', line 766

def retry_recovery_plan_execution_step: (

#reverse_replication(params = {}) ⇒ Types::ReverseReplicationResponse

Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.

Examples:

Request syntax with placeholder values


resp = client.reverse_replication({
  recovery_instance_id: "RecoveryInstanceID", # required
})

Response structure


resp.reversed_direction_source_server_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance that we want to reverse the replication for.

Returns:

See Also:



776
 
# File 'sig/client.rbs', line 776

def reverse_replication: (

#start_failback_launch(params = {}) ⇒ Types::StartFailbackLaunchResponse

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

Examples:

Request syntax with placeholder values


resp = client.start_failback_launch({
  recovery_instance_i_ds: ["RecoveryInstanceID"], # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.job_id #=> String
resp.job.arn #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.job.initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].source_server_id #=> String
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.job.participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_i_ds (required, Array<String>) —

    The IDs of the Recovery Instance whose failback launch we want to request.

  • :tags (Hash<String,String>) —

    The tags to be associated with the failback launch Job.

Returns:

See Also:



786
 
# File 'sig/client.rbs', line 786

def start_failback_launch: (

#start_recovery(params = {}) ⇒ Types::StartRecoveryResponse

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

Examples:

Request syntax with placeholder values


resp = client.start_recovery({
  source_servers: [ # required
    {
      source_server_id: "SourceServerID", # required
      recovery_snapshot_id: "RecoverySnapshotID",
    },
  ],
  is_drill: false,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.job_id #=> String
resp.job.arn #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.job.initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].source_server_id #=> String
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.job.participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_servers (required, Array<Types::StartRecoveryRequestSourceServer>) —

    The Source Servers that we want to start a Recovery Job for.

  • :is_drill (Boolean) —

    Whether this Source Server Recovery operation is a drill or not.

  • :tags (Hash<String,String>) —

    The tags to be associated with the Recovery Job.

Returns:

See Also:



797
 
# File 'sig/client.rbs', line 797

def start_recovery: (

#start_recovery_plan_execution(params = {}) ⇒ Types::StartRecoveryPlanExecutionResponse

Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.

Examples:

Request syntax with placeholder values


resp = client.start_recovery_plan_execution({
  recovery_plan_arn: "StrictDRSARN", # required
  mode: "DRILL", # required, accepts DRILL, RECOVERY
  client_token: "ClientIdempotencyToken",
  source_servers: [
    {
      source_server_id: "SourceServerID", # required
      recovery_snapshot_id: "RecoverySnapshotID", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.recovery_plan_execution.recovery_plan_execution_arn #=> String
resp.recovery_plan_execution.recovery_plan_arn #=> String
resp.recovery_plan_execution.mode #=> String, one of "DRILL", "RECOVERY"
resp.recovery_plan_execution.status #=> String, one of "CREATED", "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.recovery_plan_execution.started_at #=> String
resp.recovery_plan_execution.completed_at #=> String
resp.recovery_plan_execution.error_detail.message #=> String
resp.recovery_plan_execution.error_detail.code #=> String
resp.recovery_plan_execution.tags #=> Hash
resp.recovery_plan_execution.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan to execute.

  • :mode (required, String) —

    The execution mode (DRILL or RECOVERY).

  • :client_token (String) —

    A unique string provided to ensure request idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :source_servers (Array<Types::RecoveryPlanExecutionSourceServer>) —

    Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

  • :tags (Hash<String,String>) —

    The tags to apply to the Recovery Plan execution.

Returns:

See Also:



814
 
# File 'sig/client.rbs', line 814

def start_recovery_plan_execution: (

#start_replication(params = {}) ⇒ Types::StartReplicationResponse

Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.

Examples:

Request syntax with placeholder values


resp = client.start_replication({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server.source_server_id #=> String
resp.source_server.arn #=> String
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
resp.source_server.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.source_server.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.steps #=> Array
resp.source_server.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.source_server.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_error.raw_error #=> String
resp.source_server.data_replication_info.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.first_byte_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.job_id #=> String
resp.source_server.life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.source_server.life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.source_server.source_properties.last_updated_date_time #=> String
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.identification_hints.fqdn #=> String
resp.source_server.source_properties.identification_hints.hostname #=> String
resp.source_server.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> String
resp.source_server.source_properties.network_interfaces #=> Array
resp.source_server.source_properties.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.network_interfaces[0].ips #=> Array
resp.source_server.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_server.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_server.source_properties.disks #=> Array
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.cpus #=> Array
resp.source_server.source_properties.cpus[0].cores #=> Integer
resp.source_server.source_properties.cpus[0].model_name #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_network_id #=> String
resp.source_server.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server to start replication for.

Returns:

See Also:



833
 
# File 'sig/client.rbs', line 833

def start_replication: (

#start_source_network_recovery(params = {}) ⇒ Types::StartSourceNetworkRecoveryResponse

Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.

Examples:

Request syntax with placeholder values


resp = client.start_source_network_recovery({
  source_networks: [ # required
    {
      source_network_id: "SourceNetworkID", # required
      cfn_stack_name: "CfnStackName",
    },
  ],
  deploy_as_new: false,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.job_id #=> String
resp.job.arn #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.job.initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].source_server_id #=> String
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.job.participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_networks (required, Array<Types::StartSourceNetworkRecoveryRequestNetworkEntry>) —

    The Source Networks that we want to start a Recovery Job for.

  • :deploy_as_new (Boolean) —

    Don't update existing CloudFormation Stack, recover the network using a new stack.

  • :tags (Hash<String,String>) —

    The tags to be associated with the Source Network recovery Job.

Returns:

See Also:



843
 
# File 'sig/client.rbs', line 843

def start_source_network_recovery: (

#start_source_network_replication(params = {}) ⇒ Types::StartSourceNetworkReplicationResponse

Starts replication for a Source Network. This action would make the Source Network protected.

Examples:

Request syntax with placeholder values


resp = client.start_source_network_replication({
  source_network_id: "SourceNetworkID", # required
})

Response structure


resp.source_network.source_network_id #=> String
resp.source_network.source_vpc_id #=> String
resp.source_network.arn #=> String
resp.source_network.tags #=> Hash
resp.source_network.tags["TagKey"] #=> String
resp.source_network.replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.source_network.replication_status_details #=> String
resp.source_network.cfn_stack_name #=> String
resp.source_network.source_region #=> String
resp.source_network. #=> String
resp.source_network.last_recovery.api_call_date_time #=> Time
resp.source_network.last_recovery.job_id #=> String
resp.source_network.last_recovery.last_recovery_result #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCESS", "FAIL", "PARTIAL_SUCCESS", "ASSOCIATE_SUCCESS", "ASSOCIATE_FAIL"
resp.source_network.launched_vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    ID of the Source Network to replicate.

Returns:

See Also:



860
 
# File 'sig/client.rbs', line 860

def start_source_network_replication: (

#stop_failback(params = {}) ⇒ Struct

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

Examples:

Request syntax with placeholder values


resp = client.stop_failback({
  recovery_instance_id: "RecoveryInstanceID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance we want to stop failback for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



866
 
# File 'sig/client.rbs', line 866

def stop_failback: (

#stop_replication(params = {}) ⇒ Types::StopReplicationResponse

Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

Examples:

Request syntax with placeholder values


resp = client.stop_replication({
  source_server_id: "SourceServerID", # required
})

Response structure


resp.source_server.source_server_id #=> String
resp.source_server.arn #=> String
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
resp.source_server.data_replication_info.replicated_disks[0].total_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].replicated_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].rescanned_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].volume_status #=> String, one of "REGULAR", "CONTAINS_MARKETPLACE_PRODUCT_CODES", "MISSING_VOLUME_ATTRIBUTES", "MISSING_VOLUME_ATTRIBUTES_AND_PRECHECK_UNAVAILABLE", "PENDING"
resp.source_server.data_replication_info.data_replication_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.data_replication_initiation.start_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.steps #=> Array
resp.source_server.data_replication_info.data_replication_initiation.steps[0].name #=> String, one of "WAIT", "CREATE_SECURITY_GROUP", "LAUNCH_REPLICATION_SERVER", "BOOT_REPLICATION_SERVER", "AUTHENTICATE_WITH_SERVICE", "DOWNLOAD_REPLICATION_SOFTWARE", "CREATE_STAGING_DISKS", "ATTACH_STAGING_DISKS", "PAIR_REPLICATION_SERVER_WITH_AGENT", "CONNECT_AGENT_TO_REPLICATION_SERVER", "START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_initiation.steps[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "SKIPPED"
resp.source_server.data_replication_info.data_replication_error.error #=> String, one of "AGENT_NOT_SEEN", "SNAPSHOTS_FAILURE", "NOT_CONVERGING", "UNSTABLE_NETWORK", "FAILED_TO_CREATE_SECURITY_GROUP", "FAILED_TO_LAUNCH_REPLICATION_SERVER", "FAILED_TO_BOOT_REPLICATION_SERVER", "FAILED_TO_AUTHENTICATE_WITH_SERVICE", "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", "FAILED_TO_CREATE_STAGING_DISKS", "FAILED_TO_ATTACH_STAGING_DISKS", "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", "FAILED_TO_START_DATA_TRANSFER"
resp.source_server.data_replication_info.data_replication_error.raw_error #=> String
resp.source_server.data_replication_info.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.first_byte_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.api_call_date_time #=> String
resp.source_server.life_cycle.last_launch.initiated.job_id #=> String
resp.source_server.life_cycle.last_launch.initiated.type #=> String, one of "RECOVERY", "DRILL"
resp.source_server.life_cycle.last_launch.status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.source_server.source_properties.last_updated_date_time #=> String
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.identification_hints.fqdn #=> String
resp.source_server.source_properties.identification_hints.hostname #=> String
resp.source_server.source_properties.identification_hints.vm_ware_uuid #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> String
resp.source_server.source_properties.network_interfaces #=> Array
resp.source_server.source_properties.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.network_interfaces[0].ips #=> Array
resp.source_server.source_properties.network_interfaces[0].ips[0] #=> String
resp.source_server.source_properties.network_interfaces[0].is_primary #=> Boolean
resp.source_server.source_properties.disks #=> Array
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.cpus #=> Array
resp.source_server.source_properties.cpus[0].cores #=> Integer
resp.source_server.source_properties.cpus[0].model_name #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_properties.architecture #=> String, one of "x86_64", "arm64"
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_network_id #=> String
resp.source_server.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server to stop replication for.

Returns:

See Also:



876
 
# File 'sig/client.rbs', line 876

def stop_replication: (

#stop_source_network_replication(params = {}) ⇒ Types::StopSourceNetworkReplicationResponse

Stops replication for a Source Network. This action would make the Source Network unprotected.

Examples:

Request syntax with placeholder values


resp = client.stop_source_network_replication({
  source_network_id: "SourceNetworkID", # required
})

Response structure


resp.source_network.source_network_id #=> String
resp.source_network.source_vpc_id #=> String
resp.source_network.arn #=> String
resp.source_network.tags #=> Hash
resp.source_network.tags["TagKey"] #=> String
resp.source_network.replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.source_network.replication_status_details #=> String
resp.source_network.cfn_stack_name #=> String
resp.source_network.source_region #=> String
resp.source_network. #=> String
resp.source_network.last_recovery.api_call_date_time #=> Time
resp.source_network.last_recovery.job_id #=> String
resp.source_network.last_recovery.last_recovery_result #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCESS", "FAIL", "PARTIAL_SUCCESS", "ASSOCIATE_SUCCESS", "ASSOCIATE_FAIL"
resp.source_network.launched_vpc_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    ID of the Source Network to stop replication.

Returns:

See Also:



886
 
# File 'sig/client.rbs', line 886

def stop_source_network_replication: (

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ARN", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of the resource for which tags are to be added or updated.

  • :tags (required, Hash<String,String>) —

    Array of tags to be added or updated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



892
 
# File 'sig/client.rbs', line 892

def tag_resource: (

#terminate_recovery_instances(params = {}) ⇒ Types::TerminateRecoveryInstancesResponse

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

Examples:

Request syntax with placeholder values


resp = client.terminate_recovery_instances({
  recovery_instance_i_ds: ["RecoveryInstanceID"], # required
})

Response structure


resp.job.job_id #=> String
resp.job.arn #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.job.initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].source_server_id #=> String
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.job.participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.job.participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.job.participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_i_ds (required, Array<String>) —

    The IDs of the Recovery Instances that should be terminated.

Returns:

See Also:



903
 
# File 'sig/client.rbs', line 903

def terminate_recovery_instances: (

#untag_resource(params = {}) ⇒ Struct

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ARN", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of the resource for which tags are to be removed.

  • :tag_keys (required, Array<String>) —

    Array of tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



909
 
# File 'sig/client.rbs', line 909

def untag_resource: (

#update_failback_replication_configuration(params = {}) ⇒ Struct

Allows you to update the failback replication configuration of a Recovery Instance by ID.

Examples:

Request syntax with placeholder values


resp = client.update_failback_replication_configuration({
  recovery_instance_id: "RecoveryInstanceID", # required
  name: "BoundedString",
  bandwidth_throttling: 1,
  use_private_ip: false,
  internet_protocol: "IPV4", # accepts IPV4, IPV6
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance.

  • :name (String) —

    The name of the Failback Replication Configuration.

  • :bandwidth_throttling (Integer) —

    Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.

  • :use_private_ip (Boolean) —

    Whether to use Private IP for the failback replication of the Recovery Instance.

  • :internet_protocol (String) —

    Which version of the Internet Protocol to use for replication of data. (IPv4 or IPv6)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



916
 
# File 'sig/client.rbs', line 916

def update_failback_replication_configuration: (

#update_launch_configuration(params = {}) ⇒ Types::LaunchConfiguration

Updates a LaunchConfiguration by Source Server ID.

Examples:

Request syntax with placeholder values


resp = client.update_launch_configuration({
  source_server_id: "SourceServerID", # required
  name: "SmallBoundedString",
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC, IN_AWS
  copy_private_ip: false,
  copy_tags: false,
  licensing: {
    os_byol: false,
  },
  post_launch_enabled: false,
  launch_into_instance_properties: {
    launch_into_ec2_instance_id: "EC2InstanceID",
  },
  recovery_mode: "FAST", # accepts FAST, OPTIMAL
})

Response structure


resp.source_server_id #=> String
resp.name #=> String
resp.ec2_launch_template_id #=> String
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
resp.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.licensing.os_byol #=> Boolean
resp.post_launch_enabled #=> Boolean
resp.launch_into_instance_properties.launch_into_ec2_instance_id #=> String
resp.recovery_mode #=> String, one of "FAST", "OPTIMAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server that we want to retrieve a Launch Configuration for.

  • :name (String) —

    The name of the launch configuration.

  • :launch_disposition (String) —

    The state of the Recovery Instance in EC2 after the recovery operation.

  • :target_instance_type_right_sizing_method (String) —

    Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

  • :copy_private_ip (Boolean) —

    Whether we should copy the Private IP of the Source Server to the Recovery Instance.

  • :copy_tags (Boolean) —

    Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

  • :licensing (Types::Licensing) —

    The licensing configuration to be used for this launch configuration.

  • :post_launch_enabled (Boolean) —

    Whether we want to enable post-launch actions for the Source Server.

  • :launch_into_instance_properties (Types::LaunchIntoInstanceProperties) —

    Launch into existing instance properties.

  • :recovery_mode (String) —

    Recovery mode.

Returns:

See Also:



940
 
# File 'sig/client.rbs', line 940

def update_launch_configuration: (

#update_launch_configuration_template(params = {}) ⇒ Types::UpdateLaunchConfigurationTemplateResponse

Updates an existing Launch Configuration Template by ID.

Examples:

Request syntax with placeholder values


resp = client.update_launch_configuration_template({
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC, IN_AWS
  copy_private_ip: false,
  copy_tags: false,
  licensing: {
    os_byol: false,
  },
  export_bucket_arn: "ARN",
  post_launch_enabled: false,
  launch_into_source_instance: false,
  recovery_mode: "FAST", # accepts FAST, OPTIMAL
})

Response structure


resp.launch_configuration_template.launch_configuration_template_id #=> String
resp.launch_configuration_template.arn #=> String
resp.launch_configuration_template.tags #=> Hash
resp.launch_configuration_template.tags["TagKey"] #=> String
resp.launch_configuration_template.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.launch_configuration_template.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
resp.launch_configuration_template.copy_private_ip #=> Boolean
resp.launch_configuration_template.copy_tags #=> Boolean
resp.launch_configuration_template.licensing.os_byol #=> Boolean
resp.launch_configuration_template.export_bucket_arn #=> String
resp.launch_configuration_template.post_launch_enabled #=> Boolean
resp.launch_configuration_template.launch_into_source_instance #=> Boolean
resp.launch_configuration_template.recovery_mode #=> String, one of "FAST", "OPTIMAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch_configuration_template_id (required, String) —

    Launch Configuration Template ID.

  • :launch_disposition (String) —

    Launch disposition.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :licensing (Types::Licensing) —

    Licensing.

  • :export_bucket_arn (String) —

    S3 bucket ARN to export Source Network templates.

  • :post_launch_enabled (Boolean) —

    Whether we want to activate post-launch actions.

  • :launch_into_source_instance (Boolean) —

    DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

  • :recovery_mode (String) —

    Recovery mode.

Returns:

See Also:



963
 
# File 'sig/client.rbs', line 963

def update_launch_configuration_template: (

#update_recovery_plan(params = {}) ⇒ Types::UpdateRecoveryPlanResponse

Updates a Recovery Plan's name or description.

Examples:

Request syntax with placeholder values


resp = client.update_recovery_plan({
  recovery_plan_arn: "StrictDRSARN", # required
  name: "RecoveryPlanName",
  description: "RecoveryPlanDescription",
})

Response structure


resp.recovery_plan.recovery_plan_arn #=> String
resp.recovery_plan.name #=> String
resp.recovery_plan.description #=> String
resp.recovery_plan.status #=> String, one of "ACTIVE", "INVALID"
resp.recovery_plan.created_at #=> String
resp.recovery_plan.updated_at #=> String
resp.recovery_plan.tags #=> Hash
resp.recovery_plan.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_arn (required, String) —

    The ARN of the Recovery Plan to update.

  • :name (String) —

    The name of a Recovery Plan.

  • :description (String) —

    The description of a Recovery Plan.

Returns:

See Also:



984
 
# File 'sig/client.rbs', line 984

def update_recovery_plan: (

#update_recovery_plan_execution_step(params = {}) ⇒ Types::UpdateRecoveryPlanExecutionStepResponse

Updates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step that is in NOT_STARTED status.

Examples:

Request syntax with placeholder values


resp = client.update_recovery_plan_execution_step({
  recovery_plan_execution_step_arn: "StrictDRSARN", # required
  status: "NOT_STARTED", # accepts NOT_STARTED, EXECUTING, WAITING, COMPLETED, FAILED, TIMED_OUT, SKIPPED
  servers: [
    {
      server_arn: "SourceServerARN", # required
      impact_level: "CRITICAL", # accepts CRITICAL, OPTIONAL
    },
  ],
  wait_duration_minutes: 1,
})

Response structure


resp.recovery_plan_execution_step.recovery_plan_execution_step_arn #=> String
resp.recovery_plan_execution_step.step_index #=> Integer
resp.recovery_plan_execution_step.status #=> String, one of "NOT_STARTED", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "TIMED_OUT", "SKIPPED"
resp.recovery_plan_execution_step.step_name #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers #=> Array
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_execution_step.configuration.execution_server_step_configuration.servers[0].job_id #=> String
resp.recovery_plan_execution_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_execution_step.error_detail.message #=> String
resp.recovery_plan_execution_step.error_detail.code #=> String
resp.recovery_plan_execution_step.attempt #=> Integer
resp.recovery_plan_execution_step.created_at #=> String
resp.recovery_plan_execution_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_execution_step_arn (required, String) —

    The ARN of the execution step to update.

  • :status (String) —

    Only SKIPPED is accepted. Step must be in NOT_STARTED or FAILED status.

  • :servers (Array<Types::RecoveryPlanServer>) —

    Full replacement of the server list. Only allowed when the step is in NOT_STARTED status (Server type steps only).

  • :wait_duration_minutes (Integer) —

    Updated wait duration. Only allowed when the step is in NOT_STARTED status (Wait type steps only).

Returns:

See Also:



996
 
# File 'sig/client.rbs', line 996

def update_recovery_plan_execution_step: (

#update_recovery_plan_step(params = {}) ⇒ Types::UpdateRecoveryPlanStepResponse

Updates a Recovery Plan step's name or configuration. Step type is immutable.

Examples:

Request syntax with placeholder values


resp = client.update_recovery_plan_step({
  recovery_plan_step_arn: "StrictDRSARN", # required
  step_name: "RecoveryPlanStepName",
  configuration: {
    server_step_configuration: {
      servers: [ # required
        {
          server_arn: "SourceServerARN", # required
          impact_level: "CRITICAL", # accepts CRITICAL, OPTIONAL
        },
      ],
    },
    wait_step_configuration: {
      wait_duration_minutes: 1, # required
    },
  },
})

Response structure


resp.recovery_plan_step.recovery_plan_step_arn #=> String
resp.recovery_plan_step.step_order #=> Integer
resp.recovery_plan_step.step_name #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers #=> Array
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].server_arn #=> String
resp.recovery_plan_step.configuration.server_step_configuration.servers[0].impact_level #=> String, one of "CRITICAL", "OPTIONAL"
resp.recovery_plan_step.configuration.wait_step_configuration.wait_duration_minutes #=> Integer
resp.recovery_plan_step.created_at #=> String
resp.recovery_plan_step.updated_at #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :recovery_plan_step_arn (required, String) —

    The ARN of the Recovery Plan step to update.

  • :step_name (String) —

    The name of a Recovery Plan Step.

  • :configuration (Types::RecoveryPlanStepConfiguration) —

    Type-specific configuration for a recovery plan step. Exactly one member must be set.

Returns:

See Also:



1014
 
# File 'sig/client.rbs', line 1014

def update_recovery_plan_step: (

#update_replication_configuration(params = {}) ⇒ Types::ReplicationConfiguration

Allows you to update a ReplicationConfiguration by Source Server ID.

Examples:

Request syntax with placeholder values


resp = client.update_replication_configuration({
  source_server_id: "SourceServerID", # required
  name: "SmallBoundedString",
  staging_area_subnet_id: "SubnetID",
  associate_default_security_group: false,
  replication_servers_security_groups_i_ds: ["SecurityGroupID"],
  replication_server_instance_type: "EC2InstanceType",
  use_dedicated_replication_server: false,
  default_large_staging_disk_type: "GP2", # accepts GP2, GP3, ST1, AUTO
  replicated_disks: [
    {
      device_name: "BoundedString",
      is_boot_disk: false,
      staging_disk_type: "AUTO", # accepts AUTO, GP2, GP3, IO1, SC1, ST1, STANDARD
      iops: 1,
      throughput: 1,
      optimized_staging_disk_type: "AUTO", # accepts AUTO, GP2, GP3, IO1, SC1, ST1, STANDARD
    },
  ],
  ebs_encryption: "DEFAULT", # accepts DEFAULT, CUSTOM, NONE
  ebs_encryption_key_arn: "ARN",
  bandwidth_throttling: 1,
  data_plane_routing: "PRIVATE_IP", # accepts PRIVATE_IP, PUBLIC_IP
  create_public_ip: false,
  staging_area_tags: {
    "TagKey" => "TagValue",
  },
  pit_policy: [
    {
      rule_id: 1,
      units: "MINUTE", # required, accepts MINUTE, HOUR, DAY
      interval: 1, # required
      retention_duration: 1, # required
      enabled: false,
    },
  ],
  auto_replicate_new_disks: false,
  internet_protocol: "IPV4", # accepts IPV4, IPV6
})

Response structure


resp.source_server_id #=> String
resp.name #=> String
resp.staging_area_subnet_id #=> String
resp.associate_default_security_group #=> Boolean
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.replication_server_instance_type #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].throughput #=> Integer
resp.replicated_disks[0].optimized_staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.ebs_encryption_key_arn #=> String
resp.bandwidth_throttling #=> Integer
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.create_public_ip #=> Boolean
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].enabled #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.internet_protocol #=> String, one of "IPV4", "IPV6"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_server_id (required, String) —

    The ID of the Source Server for this Replication Configuration.

  • :name (String) —

    The name of the Replication Configuration.

  • :staging_area_subnet_id (String) —

    The subnet to be used by the replication staging area.

  • :associate_default_security_group (Boolean) —

    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

  • :replication_servers_security_groups_i_ds (Array<String>) —

    The security group IDs that will be used by the replication server.

  • :replication_server_instance_type (String) —

    The instance type to be used for the replication server.

  • :use_dedicated_replication_server (Boolean) —

    Whether to use a dedicated Replication Server in the replication staging area.

  • :default_large_staging_disk_type (String) —

    The Staging Disk EBS volume type to be used during replication.

  • :replicated_disks (Array<Types::ReplicationConfigurationReplicatedDisk>) —

    The configuration of the disks of the Source Server to be replicated.

  • :ebs_encryption (String) —

    The type of EBS encryption to be used during replication.

  • :ebs_encryption_key_arn (String) —

    The ARN of the EBS encryption key to be used during replication.

  • :bandwidth_throttling (Integer) —

    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

  • :data_plane_routing (String) —

    The data plane routing mechanism that will be used for replication.

  • :create_public_ip (Boolean) —

    Whether to create a Public IP for the Recovery Instance by default.

  • :staging_area_tags (Hash<String,String>) —

    A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

  • :pit_policy (Array<Types::PITPolicyRule>) —

    The Point in time (PIT) policy to manage snapshots taken during replication.

  • :auto_replicate_new_disks (Boolean) —

    Whether to allow the AWS replication agent to automatically replicate newly added disks.

  • :internet_protocol (String) —

    Which version of the Internet Protocol to use for replication of data. (IPv4 or IPv6)

Returns:

See Also:



1043
 
# File 'sig/client.rbs', line 1043

def update_replication_configuration: (

#update_replication_configuration_template(params = {}) ⇒ Types::ReplicationConfigurationTemplate

Updates a ReplicationConfigurationTemplate by ID.

Examples:

Request syntax with placeholder values


resp = client.update_replication_configuration_template({
  replication_configuration_template_id: "ReplicationConfigurationTemplateID", # required
  arn: "ARN",
  staging_area_subnet_id: "SubnetID",
  associate_default_security_group: false,
  replication_servers_security_groups_i_ds: ["SecurityGroupID"],
  replication_server_instance_type: "EC2InstanceType",
  use_dedicated_replication_server: false,
  default_large_staging_disk_type: "GP2", # accepts GP2, GP3, ST1, AUTO
  ebs_encryption: "DEFAULT", # accepts DEFAULT, CUSTOM, NONE
  ebs_encryption_key_arn: "ARN",
  bandwidth_throttling: 1,
  data_plane_routing: "PRIVATE_IP", # accepts PRIVATE_IP, PUBLIC_IP
  create_public_ip: false,
  staging_area_tags: {
    "TagKey" => "TagValue",
  },
  pit_policy: [
    {
      rule_id: 1,
      units: "MINUTE", # required, accepts MINUTE, HOUR, DAY
      interval: 1, # required
      retention_duration: 1, # required
      enabled: false,
    },
  ],
  auto_replicate_new_disks: false,
  internet_protocol: "IPV4", # accepts IPV4, IPV6
})

Response structure


resp.replication_configuration_template_id #=> String
resp.arn #=> String
resp.staging_area_subnet_id #=> String
resp.associate_default_security_group #=> Boolean
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.replication_server_instance_type #=> String
resp.use_dedicated_replication_server #=> Boolean
resp.default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.ebs_encryption_key_arn #=> String
resp.bandwidth_throttling #=> Integer
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.create_public_ip #=> Boolean
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].enabled #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.internet_protocol #=> String, one of "IPV4", "IPV6"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :replication_configuration_template_id (required, String) —

    The Replication Configuration Template ID.

  • :arn (String) —

    The Replication Configuration Template ARN.

  • :staging_area_subnet_id (String) —

    The subnet to be used by the replication staging area.

  • :associate_default_security_group (Boolean) —

    Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.

  • :replication_servers_security_groups_i_ds (Array<String>) —

    The security group IDs that will be used by the replication server.

  • :replication_server_instance_type (String) —

    The instance type to be used for the replication server.

  • :use_dedicated_replication_server (Boolean) —

    Whether to use a dedicated Replication Server in the replication staging area.

  • :default_large_staging_disk_type (String) —

    The Staging Disk EBS volume type to be used during replication.

  • :ebs_encryption (String) —

    The type of EBS encryption to be used during replication.

  • :ebs_encryption_key_arn (String) —

    The ARN of the EBS encryption key to be used during replication.

  • :bandwidth_throttling (Integer) —

    Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

  • :data_plane_routing (String) —

    The data plane routing mechanism that will be used for replication.

  • :create_public_ip (Boolean) —

    Whether to create a Public IP for the Recovery Instance by default.

  • :staging_area_tags (Hash<String,String>) —

    A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

  • :pit_policy (Array<Types::PITPolicyRule>) —

    The Point in time (PIT) policy to manage snapshots taken during replication.

  • :auto_replicate_new_disks (Boolean) —

    Whether to allow the AWS replication agent to automatically replicate newly added disks.

  • :internet_protocol (String) —

    Which version of the Internet Protocol to use for replication of data. (IPv4 or IPv6)

Returns:

See Also:



1104
 
# File 'sig/client.rbs', line 1104

def update_replication_configuration_template: (

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


4570
4571
4572
 
# File 'lib/aws-sdk-drs/client.rb', line 4570

def waiter_names
  []
end