Class: Aws::Drs::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb

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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

    Your AWS credentials. This can be an 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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :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_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.

  • :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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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_proxy (URI::HTTP, String) —

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :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_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_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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :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.



385
386
387
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 385

def initialize(*args)
  super
end

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({
  cfn_stack_name: "CfnStackName", # required
  source_network_id: "SourceNetworkID", # required
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
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.job_id #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> 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.order #=> Integer
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"].type #=> String, one of "SSM_STORE", "DYNAMIC"
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.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"

Parameters:

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

    ({})

Options Hash (params):

  • :cfn_stack_name (required, String) —

    CloudFormation template to associate with a Source Network.

  • :source_network_id (required, String) —

    The Source Network ID to associate with CloudFormation template.

Returns:

See Also:



453
454
455
456
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 453

def associate_source_network_stack(params = {}, options = {})
  req = build_request(:associate_source_network_stack, params)
  req.send_request(options)
end

#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.agent_version #=> String
resp.source_server.arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.start_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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.first_byte_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.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.source_network_id #=> String
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.disks #=> Array
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.source_server.source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_server_id #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> 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:



553
554
555
556
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 553

def create_extended_source_server(params = {}, options = {})
  req = build_request(:create_extended_source_server, params)
  req.send_request(options)
end

#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({
  copy_private_ip: false,
  copy_tags: false,
  export_bucket_arn: "ARN",
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  launch_into_source_instance: false,
  licensing: {
    os_byol: false,
  },
  post_launch_enabled: false,
  tags: {
    "TagKey" => "TagValue",
  },
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC, IN_AWS
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :export_bucket_arn (String) —

    S3 bucket ARN to export Source Network templates.

  • :launch_disposition (String) —

    Launch disposition.

  • :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.

  • :licensing (Types::Licensing) —

    Licensing.

  • :post_launch_enabled (Boolean) —

    Whether we want to activate post-launch actions.

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

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

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

Returns:

See Also:



631
632
633
634
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 631

def create_launch_configuration_template(params = {}, options = {})
  req = build_request(:create_launch_configuration_template, params)
  req.send_request(options)
end

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

Creates a new ReplicationConfigurationTemplate.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.associate_default_security_group #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
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.pit_policy #=> Array
resp.pit_policy[0].enabled #=> Boolean
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.replication_configuration_template_id #=> String
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :associate_default_security_group (required, Boolean) —

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

  • :auto_replicate_new_disks (Boolean) —

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

  • :bandwidth_throttling (required, Integer) —

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

  • :create_public_ip (required, Boolean) —

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

  • :data_plane_routing (required, String) —

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

  • :default_large_staging_disk_type (required, 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.

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

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

  • :replication_server_instance_type (required, String) —

    The instance type to be used for the replication server.

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

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

  • :staging_area_subnet_id (required, String) —

    The subnet to be used by the replication staging area.

  • :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.

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

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

  • :use_dedicated_replication_server (required, Boolean) —

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

Returns:

See Also:



775
776
777
778
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 775

def create_replication_configuration_template(params = {}, options = {})
  req = build_request(:create_replication_configuration_template, params)
  req.send_request(options)
end

#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({
  origin_account_id: "AccountID", # required
  origin_region: "AwsRegion", # required
  tags: {
    "TagKey" => "TagValue",
  },
  vpc_id: "VpcID", # required
})

Response structure


resp.source_network_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :vpc_id (required, String) —

    Which VPC ID to protect.

Returns:

See Also:



817
818
819
820
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 817

def create_source_network(params = {}, options = {})
  req = build_request(:create_source_network, params)
  req.send_request(options)
end

#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:



839
840
841
842
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 839

def delete_job(params = {}, options = {})
  req = build_request(:delete_job, params)
  req.send_request(options)
end

#delete_launch_action(params = {}) ⇒ Struct

Deletes a resource launch action.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :action_id (required, String) —

    Launch action Id.

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



865
866
867
868
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 865

def delete_launch_action(params = {}, options = {})
  req = build_request(:delete_launch_action, params)
  req.send_request(options)
end

#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:



887
888
889
890
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 887

def delete_launch_configuration_template(params = {}, options = {})
  req = build_request(:delete_launch_configuration_template, params)
  req.send_request(options)
end

#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:



911
912
913
914
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 911

def delete_recovery_instance(params = {}, options = {})
  req = build_request(:delete_recovery_instance, params)
  req.send_request(options)
end

#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:



933
934
935
936
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 933

def delete_replication_configuration_template(params = {}, options = {})
  req = build_request(:delete_replication_configuration_template, params)
  req.send_request(options)
end

#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:



955
956
957
958
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 955

def delete_source_network(params = {}, options = {})
  req = build_request(:delete_source_network, params)
  req.send_request(options)
end

#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:



978
979
980
981
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 978

def delete_source_server(params = {}, options = {})
  req = build_request(:delete_source_server, params)
  req.send_request(options)
end

#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].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.conversion_properties.data_timestamp #=> String
resp.items[0].event_data.conversion_properties.force_uefi #=> Boolean
resp.items[0].event_data.conversion_properties.root_volume_name #=> 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.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.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_server_id #=> String
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.stack_name #=> String
resp.items[0].event_data.event_resource_data.source_network_data.target_vpc #=> String
resp.items[0].event_data.raw_error #=> String
resp.items[0].event_data.source_server_id #=> String
resp.items[0].event_data.target_instance_id #=> String
resp.items[0].log_date_time #=> String
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:



1040
1041
1042
1043
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1040

def describe_job_log_items(params = {}, options = {})
  req = build_request(:describe_job_log_items, params)
  req.send_request(options)
end

#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: {
    from_date: "ISO8601DatetimeString",
    job_i_ds: ["JobID"],
    to_date: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
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].job_id #=> String
resp.items[0].participating_resources #=> Array
resp.items[0].participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_resources[0].participating_resource_id.source_network_id #=> String
resp.items[0].participating_servers #=> Array
resp.items[0].participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
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.optional #=> 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.parameters #=> Hash
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.parameters["LaunchActionParameterName"].value #=> 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].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.items[0].participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_servers[0].recovery_instance_id #=> String
resp.items[0].participating_servers[0].source_server_id #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
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:



1124
1125
1126
1127
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1124

def describe_jobs(params = {}, options = {})
  req = build_request(:describe_jobs, params)
  req.send_request(options)
end

#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].arn #=> String
resp.items[0].copy_private_ip #=> Boolean
resp.items[0].copy_tags #=> Boolean
resp.items[0].export_bucket_arn #=> String
resp.items[0].launch_configuration_template_id #=> String
resp.items[0].launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.items[0].launch_into_source_instance #=> Boolean
resp.items[0].licensing.os_byol #=> Boolean
resp.items[0].post_launch_enabled #=> Boolean
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"
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:



1179
1180
1181
1182
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1179

def describe_launch_configuration_templates(params = {}, options = {})
  req = build_request(:describe_launch_configuration_templates, params)
  req.send_request(options)
end

#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.items #=> Array
resp.items[0].agent_version #=> String
resp.items[0].arn #=> String
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.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_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.eta_date_time #=> String
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
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].total_storage_bytes #=> Integer
resp.items[0].data_replication_info.staging_availability_zone #=> String
resp.items[0].data_replication_info.staging_outpost_arn #=> String
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].failback.agent_last_seen_by_service_date_time #=> String
resp.items[0].failback.elapsed_replication_duration #=> String
resp.items[0].failback.failback_client_id #=> String
resp.items[0].failback.failback_client_last_seen_by_service_date_time #=> String
resp.items[0].failback.failback_initiation_time #=> String
resp.items[0].failback.failback_job_id #=> String
resp.items[0].failback.failback_launch_type #=> String, one of "RECOVERY", "DRILL"
resp.items[0].failback.failback_to_original_server #=> Boolean
resp.items[0].failback.first_byte_date_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].is_drill #=> Boolean
resp.items[0].job_id #=> String
resp.items[0].origin_availability_zone #=> String
resp.items[0].origin_environment #=> String, one of "ON_PREMISES", "AWS"
resp.items[0].point_in_time_snapshot_date_time #=> String
resp.items[0].recovery_instance_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.disks #=> Array
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.disks[0].internal_device_name #=> String
resp.items[0].recovery_instance_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.items[0].recovery_instance_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.items[0].recovery_instance_properties.os.full_string #=> String
resp.items[0].recovery_instance_properties.ram_bytes #=> Integer
resp.items[0].source_outpost_arn #=> String
resp.items[0].source_server_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> 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:



1282
1283
1284
1285
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1282

def describe_recovery_instances(params = {}, options = {})
  req = build_request(:describe_recovery_instances, params)
  req.send_request(options)
end

#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({
  filters: {
    from_date_time: "ISO8601DatetimeString",
    to_date_time: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
  order: "ASC", # accepts ASC, DESC
  source_server_id: "SourceServerID", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Types::DescribeRecoverySnapshotsRequestFilters) —

    A set of filters 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.

  • :order (String) —

    The sorted ordering by which to return Recovery Snapshots.

  • :source_server_id (required, String) —

    Filter Recovery Snapshots by Source Server ID.

Returns:

See Also:



1339
1340
1341
1342
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1339

def describe_recovery_snapshots(params = {}, options = {})
  req = build_request(:describe_recovery_snapshots, params)
  req.send_request(options)
end

#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({
  max_results: 1,
  next_token: "PaginationToken",
  replication_configuration_template_i_ds: ["ReplicationConfigurationTemplateID"],
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].associate_default_security_group #=> Boolean
resp.items[0].auto_replicate_new_disks #=> Boolean
resp.items[0].bandwidth_throttling #=> Integer
resp.items[0].create_public_ip #=> Boolean
resp.items[0].data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
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].pit_policy #=> Array
resp.items[0].pit_policy[0].enabled #=> Boolean
resp.items[0].pit_policy[0].interval #=> Integer
resp.items[0].pit_policy[0].retention_duration #=> Integer
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].replication_configuration_template_id #=> String
resp.items[0].replication_server_instance_type #=> String
resp.items[0].replication_servers_security_groups_i_ds #=> Array
resp.items[0].replication_servers_security_groups_i_ds[0] #=> String
resp.items[0].staging_area_subnet_id #=> String
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].use_dedicated_replication_server #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of Replication Configuration Templates to retrieve.

  • :next_token (String) —

    The token of the next Replication Configuration Template to retrieve.

  • :replication_configuration_template_i_ds (Array<String>) —

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

Returns:

See Also:



1406
1407
1408
1409
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1406

def describe_replication_configuration_templates(params = {}, options = {})
  req = build_request(:describe_replication_configuration_templates, params)
  req.send_request(options)
end

#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: {
    origin_account_id: "AccountID",
    origin_region: "AwsRegion",
    source_network_i_ds: ["SourceNetworkID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].cfn_stack_name #=> 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.items[0].replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.items[0].replication_status_details #=> String
resp.items[0]. #=> String
resp.items[0].source_network_id #=> String
resp.items[0].source_region #=> String
resp.items[0].source_vpc_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> 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:



1464
1465
1466
1467
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1464

def describe_source_networks(params = {}, options = {})
  req = build_request(:describe_source_networks, params)
  req.send_request(options)
end

#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: {
    hardware_id: "BoundedString",
    source_server_i_ds: ["SourceServerID"],
    staging_account_i_ds: ["AccountID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].agent_version #=> String
resp.items[0].arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
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 "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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.items[0].data_replication_info.eta_date_time #=> String
resp.items[0].data_replication_info.lag_duration #=> String
resp.items[0].data_replication_info.replicated_disks #=> Array
resp.items[0].data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.items[0].data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.items[0].data_replication_info.staging_outpost_arn #=> String
resp.items[0].last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.items[0].life_cycle.added_to_service_date_time #=> String
resp.items[0].life_cycle.elapsed_replication_duration #=> String
resp.items[0].life_cycle.first_byte_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].life_cycle.last_seen_by_service_date_time #=> String
resp.items[0].recovery_instance_id #=> String
resp.items[0].replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.items[0].reversed_direction_source_server_arn #=> String
resp.items[0].source_cloud_properties. #=> String
resp.items[0].source_cloud_properties.origin_availability_zone #=> String
resp.items[0].source_cloud_properties.origin_region #=> String
resp.items[0].source_cloud_properties.source_outpost_arn #=> String
resp.items[0].source_network_id #=> String
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.disks #=> Array
resp.items[0].source_properties.disks[0].bytes #=> Integer
resp.items[0].source_properties.disks[0].device_name #=> String
resp.items[0].source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.items[0].source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.items[0].source_properties.os.full_string #=> String
resp.items[0].source_properties.ram_bytes #=> Integer
resp.items[0].source_properties.recommended_instance_type #=> String
resp.items[0].source_properties.supports_nitro_instances #=> Boolean
resp.items[0].source_server_id #=> String
resp.items[0].staging_area.error_message #=> String
resp.items[0].staging_area. #=> String
resp.items[0].staging_area.staging_source_server_arn #=> String
resp.items[0].staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> 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:



1573
1574
1575
1576
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1573

def describe_source_servers(params = {}, options = {})
  req = build_request(:describe_source_servers, params)
  req.send_request(options)
end

#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:



1607
1608
1609
1610
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1607

def disconnect_recovery_instance(params = {}, options = {})
  req = build_request(:disconnect_recovery_instance, params)
  req.send_request(options)
end

#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.agent_version #=> String
resp.arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.data_replication_info.staging_outpost_arn #=> String
resp.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_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.life_cycle.last_seen_by_service_date_time #=> String
resp.recovery_instance_id #=> String
resp.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.reversed_direction_source_server_arn #=> String
resp.source_cloud_properties. #=> String
resp.source_cloud_properties.origin_availability_zone #=> String
resp.source_cloud_properties.origin_region #=> String
resp.source_cloud_properties.source_outpost_arn #=> String
resp.source_network_id #=> String
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_properties.supports_nitro_instances #=> Boolean
resp.source_server_id #=> String
resp.staging_area.error_message #=> String
resp.staging_area. #=> String
resp.staging_area.staging_source_server_arn #=> String
resp.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> 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:



1725
1726
1727
1728
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1725

def disconnect_source_server(params = {}, options = {})
  req = build_request(:disconnect_source_server, params)
  req.send_request(options)
end

#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:



1754
1755
1756
1757
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1754

def export_source_network_cfn_template(params = {}, options = {})
  req = build_request(:export_source_network_cfn_template, params)
  req.send_request(options)
end

#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.bandwidth_throttling #=> Integer
resp.name #=> String
resp.recovery_instance_id #=> String
resp.use_private_ip #=> Boolean

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:



1790
1791
1792
1793
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1790

def get_failback_replication_configuration(params = {}, options = {})
  req = build_request(:get_failback_replication_configuration, params)
  req.send_request(options)
end

#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.copy_private_ip #=> Boolean
resp.copy_tags #=> Boolean
resp.ec2_launch_template_id #=> String
resp.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.launch_into_instance_properties.launch_into_ec2_instance_id #=> String
resp.licensing.os_byol #=> Boolean
resp.name #=> String
resp.post_launch_enabled #=> Boolean
resp.source_server_id #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC", "IN_AWS"

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:



1837
1838
1839
1840
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1837

def get_launch_configuration(params = {}, options = {})
  req = build_request(:get_launch_configuration, params)
  req.send_request(options)
end

#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.associate_default_security_group #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
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.name #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].enabled #=> Boolean
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].optimized_staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].throughput #=> Integer
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.source_server_id #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean

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:



1910
1911
1912
1913
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1910

def get_replication_configuration(params = {}, options = {})
  req = build_request(:get_replication_configuration, params)
  req.send_request(options)
end

#initialize_service(params = {}) ⇒ Struct

Initialize Elastic Disaster Recovery.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1923
1924
1925
1926
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1923

def initialize_service(params = {}, options = {})
  req = build_request(:initialize_service, params)
  req.send_request(options)
end

#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({
  max_results: 1,
  next_token: "PaginationToken",
  staging_account_id: "AccountID", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :staging_account_id (required, String) —

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

Returns:

See Also:



1971
1972
1973
1974
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1971

def list_extensible_source_servers(params = {}, options = {})
  req = build_request(:list_extensible_source_servers, params)
  req.send_request(options)
end

#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({
  filters: {
    action_ids: ["LaunchActionId"],
  },
  max_results: 1,
  next_token: "PaginationToken",
  resource_id: "LaunchActionResourceId", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

Returns:

See Also:



2031
2032
2033
2034
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2031

def list_launch_actions(params = {}, options = {})
  req = build_request(:list_launch_actions, params)
  req.send_request(options)
end

#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:



2069
2070
2071
2072
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2069

def list_staging_accounts(params = {}, options = {})
  req = build_request(:list_staging_accounts, params)
  req.send_request(options)
end

#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:



2098
2099
2100
2101
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2098

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

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

Puts a resource launch action.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :action_code (required, String) —

    Launch action code.

  • :action_id (required, String) —

    Launch action Id.

  • :action_version (required, String) —

    Launch action version.

  • :active (required, Boolean) —

    Whether the launch action is active.

  • :category (required, String) —

    Launch action category.

  • :description (required, String) —

    Launch action description.

  • :name (required, String) —

    Launch action name.

  • :optional (required, Boolean) —

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

  • :order (required, Integer) —

    Launch action order.

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

    Launch action parameters.

  • :resource_id (required, String) —

    Launch configuration template Id or Source Server Id

Returns:

See Also:



2195
2196
2197
2198
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2195

def put_launch_action(params = {}, options = {})
  req = build_request(:put_launch_action, params)
  req.send_request(options)
end

#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.agent_version #=> String
resp.arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
resp.data_replication_info.data_replication_initiation.start_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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.data_replication_info.eta_date_time #=> String
resp.data_replication_info.lag_duration #=> String
resp.data_replication_info.replicated_disks #=> Array
resp.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.data_replication_info.staging_outpost_arn #=> String
resp.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.life_cycle.added_to_service_date_time #=> String
resp.life_cycle.elapsed_replication_duration #=> String
resp.life_cycle.first_byte_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.life_cycle.last_seen_by_service_date_time #=> String
resp.recovery_instance_id #=> String
resp.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.reversed_direction_source_server_arn #=> String
resp.source_cloud_properties. #=> String
resp.source_cloud_properties.origin_availability_zone #=> String
resp.source_cloud_properties.origin_region #=> String
resp.source_cloud_properties.source_outpost_arn #=> String
resp.source_network_id #=> String
resp.source_properties.cpus #=> Array
resp.source_properties.cpus[0].cores #=> Integer
resp.source_properties.cpus[0].model_name #=> String
resp.source_properties.disks #=> Array
resp.source_properties.disks[0].bytes #=> Integer
resp.source_properties.disks[0].device_name #=> String
resp.source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.source_properties.os.full_string #=> String
resp.source_properties.ram_bytes #=> Integer
resp.source_properties.recommended_instance_type #=> String
resp.source_properties.supports_nitro_instances #=> Boolean
resp.source_server_id #=> String
resp.staging_area.error_message #=> String
resp.staging_area. #=> String
resp.staging_area.staging_source_server_arn #=> String
resp.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> 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:



2304
2305
2306
2307
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2304

def retry_data_replication(params = {}, options = {})
  req = build_request(:retry_data_replication, params)
  req.send_request(options)
end

#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:



2337
2338
2339
2340
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2337

def reverse_replication(params = {}, options = {})
  req = build_request(:reverse_replication, params)
  req.send_request(options)
end

#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.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
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.job_id #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> 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.order #=> Integer
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"].type #=> String, one of "SSM_STORE", "DYNAMIC"
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.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"

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:



2408
2409
2410
2411
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2408

def start_failback_launch(params = {}, options = {})
  req = build_request(:start_failback_launch, params)
  req.send_request(options)
end

#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({
  is_drill: false,
  source_servers: [ # required
    {
      recovery_snapshot_id: "RecoverySnapshotID",
      source_server_id: "SourceServerID", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
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.job_id #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> 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.order #=> Integer
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"].type #=> String, one of "SSM_STORE", "DYNAMIC"
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.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"

Parameters:

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

    ({})

Options Hash (params):

  • :is_drill (Boolean) —

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

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

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

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

    The tags to be associated with the Recovery Job.

Returns:

See Also:



2486
2487
2488
2489
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2486

def start_recovery(params = {}, options = {})
  req = build_request(:start_recovery, params)
  req.send_request(options)
end

#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.agent_version #=> String
resp.source_server.arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.start_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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.first_byte_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.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.source_network_id #=> String
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.disks #=> Array
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.source_server.source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_server_id #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> 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:



2579
2580
2581
2582
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2579

def start_replication(params = {}, options = {})
  req = build_request(:start_replication, params)
  req.send_request(options)
end

#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({
  deploy_as_new: false,
  source_networks: [ # required
    {
      cfn_stack_name: "CfnStackName",
      source_network_id: "SourceNetworkID", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.job.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
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.job_id #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> 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.order #=> Integer
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"].type #=> String, one of "SSM_STORE", "DYNAMIC"
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.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"

Parameters:

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

    ({})

Options Hash (params):

  • :deploy_as_new (Boolean) —

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

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

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

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

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

Returns:

See Also:



2658
2659
2660
2661
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2658

def start_source_network_recovery(params = {}, options = {})
  req = build_request(:start_source_network_recovery, params)
  req.send_request(options)
end

#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.arn #=> String
resp.source_network.cfn_stack_name #=> 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
resp.source_network.replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.source_network.replication_status_details #=> String
resp.source_network. #=> String
resp.source_network.source_network_id #=> String
resp.source_network.source_region #=> String
resp.source_network.source_vpc_id #=> String
resp.source_network.tags #=> Hash
resp.source_network.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_network_id (required, String) —

    ID of the Source Network to replicate.

Returns:

See Also:



2700
2701
2702
2703
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2700

def start_source_network_replication(params = {}, options = {})
  req = build_request(:start_source_network_replication, params)
  req.send_request(options)
end

#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:



2724
2725
2726
2727
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2724

def stop_failback(params = {}, options = {})
  req = build_request(:stop_failback, params)
  req.send_request(options)
end

#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.agent_version #=> String
resp.source_server.arn #=> String
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.data_replication_initiation.next_attempt_date_time #=> String
resp.source_server.data_replication_info.data_replication_initiation.start_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_state #=> String, one of "STOPPED", "INITIATING", "INITIAL_SYNC", "BACKLOG", "CREATING_SNAPSHOT", "CONTINUOUS", "PAUSED", "RESCAN", "STALLED", "DISCONNECTED"
resp.source_server.data_replication_info.eta_date_time #=> String
resp.source_server.data_replication_info.lag_duration #=> String
resp.source_server.data_replication_info.replicated_disks #=> Array
resp.source_server.data_replication_info.replicated_disks[0].backlogged_storage_bytes #=> Integer
resp.source_server.data_replication_info.replicated_disks[0].device_name #=> String
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].total_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.staging_availability_zone #=> String
resp.source_server.data_replication_info.staging_outpost_arn #=> String
resp.source_server.last_launch_result #=> String, one of "NOT_STARTED", "PENDING", "SUCCEEDED", "FAILED"
resp.source_server.life_cycle.added_to_service_date_time #=> String
resp.source_server.life_cycle.elapsed_replication_duration #=> String
resp.source_server.life_cycle.first_byte_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.life_cycle.last_seen_by_service_date_time #=> String
resp.source_server.recovery_instance_id #=> String
resp.source_server.replication_direction #=> String, one of "FAILOVER", "FAILBACK"
resp.source_server.reversed_direction_source_server_arn #=> String
resp.source_server.source_cloud_properties. #=> String
resp.source_server.source_cloud_properties.origin_availability_zone #=> String
resp.source_server.source_cloud_properties.origin_region #=> String
resp.source_server.source_cloud_properties.source_outpost_arn #=> String
resp.source_server.source_network_id #=> String
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.disks #=> Array
resp.source_server.source_properties.disks[0].bytes #=> Integer
resp.source_server.source_properties.disks[0].device_name #=> String
resp.source_server.source_properties.identification_hints.aws_instance_id #=> 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.last_updated_date_time #=> String
resp.source_server.source_properties.network_interfaces #=> Array
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.network_interfaces[0].mac_address #=> String
resp.source_server.source_properties.os.full_string #=> String
resp.source_server.source_properties.ram_bytes #=> Integer
resp.source_server.source_properties.recommended_instance_type #=> String
resp.source_server.source_properties.supports_nitro_instances #=> Boolean
resp.source_server.source_server_id #=> String
resp.source_server.staging_area.error_message #=> String
resp.source_server.staging_area. #=> String
resp.source_server.staging_area.staging_source_server_arn #=> String
resp.source_server.staging_area.status #=> String, one of "EXTENDED", "EXTENSION_ERROR", "NOT_EXTENDED"
resp.source_server.tags #=> Hash
resp.source_server.tags["TagKey"] #=> 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:



2818
2819
2820
2821
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2818

def stop_replication(params = {}, options = {})
  req = build_request(:stop_replication, params)
  req.send_request(options)
end

#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.arn #=> String
resp.source_network.cfn_stack_name #=> 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
resp.source_network.replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.source_network.replication_status_details #=> String
resp.source_network. #=> String
resp.source_network.source_network_id #=> String
resp.source_network.source_region #=> String
resp.source_network.source_vpc_id #=> String
resp.source_network.tags #=> Hash
resp.source_network.tags["TagKey"] #=> 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:



2860
2861
2862
2863
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2860

def stop_source_network_replication(params = {}, options = {})
  req = build_request(:stop_source_network_replication, params)
  req.send_request(options)
end

#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:



2892
2893
2894
2895
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2892

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#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.arn #=> String
resp.job.creation_date_time #=> String
resp.job.end_date_time #=> String
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.job_id #=> String
resp.job.participating_resources #=> Array
resp.job.participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_resources[0].participating_resource_id.source_network_id #=> String
resp.job.participating_servers #=> Array
resp.job.participating_servers[0].launch_actions_status.runs #=> Array
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.action_id #=> String
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.active #=> Boolean
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].action.description #=> String
resp.job.participating_servers[0].launch_actions_status.runs[0].action.name #=> 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.order #=> Integer
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"].type #=> String, one of "SSM_STORE", "DYNAMIC"
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.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.job.participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
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.ssm_agent_discovery_datetime #=> String
resp.job.participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.job.participating_servers[0].recovery_instance_id #=> String
resp.job.participating_servers[0].source_server_id #=> String
resp.job.status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.job.tags #=> Hash
resp.job.tags["TagKey"] #=> String
resp.job.type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"

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:



2955
2956
2957
2958
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2955

def terminate_recovery_instances(params = {}, options = {})
  req = build_request(:terminate_recovery_instances, params)
  req.send_request(options)
end

#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:



2982
2983
2984
2985
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2982

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#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({
  bandwidth_throttling: 1,
  name: "BoundedString",
  recovery_instance_id: "RecoveryInstanceID", # required
  use_private_ip: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :bandwidth_throttling (Integer) —

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

  • :name (String) —

    The name of the Failback Replication Configuration.

  • :recovery_instance_id (required, String) —

    The ID of the Recovery Instance.

  • :use_private_ip (Boolean) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3019
3020
3021
3022
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 3019

def update_failback_replication_configuration(params = {}, options = {})
  req = build_request(:update_failback_replication_configuration, params)
  req.send_request(options)
end

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

Updates a LaunchConfiguration by Source Server ID.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :launch_disposition (String) —

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

  • :launch_into_instance_properties (Types::LaunchIntoInstanceProperties) —

    Launch into existing instance properties.

  • :licensing (Types::Licensing) —

    The licensing configuration to be used for this launch configuration.

  • :name (String) —

    The name of the launch configuration.

  • :post_launch_enabled (Boolean) —

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

  • :source_server_id (required, String) —

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

  • :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.

Returns:

See Also:



3107
3108
3109
3110
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 3107

def update_launch_configuration(params = {}, options = {})
  req = build_request(:update_launch_configuration, params)
  req.send_request(options)
end

#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({
  copy_private_ip: false,
  copy_tags: false,
  export_bucket_arn: "ARN",
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  launch_into_source_instance: false,
  licensing: {
    os_byol: false,
  },
  post_launch_enabled: false,
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC, IN_AWS
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :export_bucket_arn (String) —

    S3 bucket ARN to export Source Network templates.

  • :launch_configuration_template_id (required, String) —

    Launch Configuration Template ID.

  • :launch_disposition (String) —

    Launch disposition.

  • :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.

  • :licensing (Types::Licensing) —

    Licensing.

  • :post_launch_enabled (Boolean) —

    Whether we want to activate post-launch actions.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

Returns:

See Also:



3182
3183
3184
3185
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 3182

def update_launch_configuration_template(params = {}, options = {})
  req = build_request(:update_launch_configuration_template, params)
  req.send_request(options)
end

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

Response structure


resp.associate_default_security_group #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
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.name #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].enabled #=> Boolean
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.replicated_disks #=> Array
resp.replicated_disks[0].device_name #=> String
resp.replicated_disks[0].iops #=> Integer
resp.replicated_disks[0].is_boot_disk #=> Boolean
resp.replicated_disks[0].optimized_staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].staging_disk_type #=> String, one of "AUTO", "GP2", "GP3", "IO1", "SC1", "ST1", "STANDARD"
resp.replicated_disks[0].throughput #=> Integer
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.source_server_id #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :associate_default_security_group (Boolean) —

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

  • :auto_replicate_new_disks (Boolean) —

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

  • :bandwidth_throttling (Integer) —

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

  • :create_public_ip (Boolean) —

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

  • :data_plane_routing (String) —

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

  • :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.

  • :name (String) —

    The name of the Replication Configuration.

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

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

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

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

  • :replication_server_instance_type (String) —

    The instance type to be used for the replication server.

  • :replication_servers_security_groups_i_ds (Array<String>) —

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

  • :source_server_id (required, String) —

    The ID of the Source Server for this Replication Configuration.

  • :staging_area_subnet_id (String) —

    The subnet to be used by the replication staging area.

  • :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.

  • :use_dedicated_replication_server (Boolean) —

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

Returns:

See Also:



3345
3346
3347
3348
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 3345

def update_replication_configuration(params = {}, options = {})
  req = build_request(:update_replication_configuration, params)
  req.send_request(options)
end

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

Updates a ReplicationConfigurationTemplate by ID.

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.associate_default_security_group #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
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.pit_policy #=> Array
resp.pit_policy[0].enabled #=> Boolean
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.replication_configuration_template_id #=> String
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :arn (String) —

    The Replication Configuration Template ARN.

  • :associate_default_security_group (Boolean) —

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

  • :auto_replicate_new_disks (Boolean) —

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

  • :bandwidth_throttling (Integer) —

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

  • :create_public_ip (Boolean) —

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

  • :data_plane_routing (String) —

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

  • :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.

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

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

  • :replication_configuration_template_id (required, String) —

    The Replication Configuration Template ID.

  • :replication_server_instance_type (String) —

    The instance type to be used for the replication server.

  • :replication_servers_security_groups_i_ds (Array<String>) —

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

  • :staging_area_subnet_id (String) —

    The subnet to be used by the replication staging area.

  • :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.

  • :use_dedicated_replication_server (Boolean) —

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

Returns:

See Also:



3490
3491
3492
3493
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 3490

def update_replication_configuration_template(params = {}, options = {})
  req = build_request(:update_replication_configuration_template, params)
  req.send_request(options)
end