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.

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

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

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



370
371
372
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 370

def initialize(*args)
  super
end

Instance Method Details

#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.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.staging_availability_zone #=> 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_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:



466
467
468
469
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 466

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,
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  licensing: {
    os_byol: false,
  },
  tags: {
    "TagKey" => "TagValue",
  },
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

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.launch_configuration_template_id #=> String
resp.launch_configuration_template.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.launch_configuration_template.licensing.os_byol #=> 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"

Parameters:

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

    ({})

Options Hash (params):

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :launch_disposition (String) —

    Launch disposition.

  • :licensing (Types::Licensing) —

    Licensing.

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



527
528
529
530
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 527

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



671
672
673
674
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 671

def create_replication_configuration_template(params = {}, options = {})
  req = build_request(:create_replication_configuration_template, 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:



693
694
695
696
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 693

def delete_job(params = {}, options = {})
  req = build_request(:delete_job, 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:



715
716
717
718
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 715

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:



739
740
741
742
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 739

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:



761
762
763
764
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 761

def delete_replication_configuration_template(params = {}, options = {})
  req = build_request(:delete_replication_configuration_template, 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:



784
785
786
787
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 784

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



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

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"
resp.items[0].job_id #=> String
resp.items[0].participating_servers #=> Array
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:



901
902
903
904
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 901

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].launch_configuration_template_id #=> String
resp.items[0].launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.items[0].licensing.os_byol #=> 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"
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:



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

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



1053
1054
1055
1056
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1053

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:



1110
1111
1112
1113
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1110

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



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

def describe_replication_configuration_templates(params = {}, options = {})
  req = build_request(:describe_replication_configuration_templates, 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].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.staging_availability_zone #=> 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_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:



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

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:



1315
1316
1317
1318
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1315

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.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.staging_availability_zone #=> 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_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:



1426
1427
1428
1429
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1426

def disconnect_source_server(params = {}, options = {})
  req = build_request(:disconnect_source_server, 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:



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

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.licensing.os_byol #=> Boolean
resp.name #=> String
resp.source_server_id #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

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:



1505
1506
1507
1508
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1505

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



1578
1579
1580
1581
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1578

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:



1591
1592
1593
1594
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1591

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:



1639
1640
1641
1642
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1639

def list_extensible_source_servers(params = {}, options = {})
  req = build_request(:list_extensible_source_servers, 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:



1677
1678
1679
1680
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1677

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:



1706
1707
1708
1709
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1706

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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.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.staging_availability_zone #=> 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_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:



1808
1809
1810
1811
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1808

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:



1841
1842
1843
1844
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1841

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"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
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:



1891
1892
1893
1894
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1891

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"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
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:



1948
1949
1950
1951
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 1948

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.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.staging_availability_zone #=> 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_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:



2036
2037
2038
2039
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2036

def start_replication(params = {}, options = {})
  req = build_request(:start_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:



2060
2061
2062
2063
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2060

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.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.staging_availability_zone #=> 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_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:



2149
2150
2151
2152
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2149

def stop_replication(params = {}, options = {})
  req = build_request(:stop_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:



2181
2182
2183
2184
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2181

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"
resp.job.job_id #=> String
resp.job.participating_servers #=> Array
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:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2223

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:



2250
2251
2252
2253
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2250

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:



2287
2288
2289
2290
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2287

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
  licensing: {
    os_byol: false,
  },
  name: "SmallBoundedString",
  source_server_id: "SourceServerID", # required
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

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.licensing.os_byol #=> Boolean
resp.name #=> String
resp.source_server_id #=> String
resp.target_instance_type_right_sizing_method #=> String, one of "NONE", "BASIC"

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.

  • :licensing (Types::Licensing) —

    The licensing configuration to be used for this launch configuration.

  • :name (String) —

    The name of the launch configuration.

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



2361
2362
2363
2364
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2361

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,
  launch_configuration_template_id: "LaunchConfigurationTemplateID", # required
  launch_disposition: "STOPPED", # accepts STOPPED, STARTED
  licensing: {
    os_byol: false,
  },
  target_instance_type_right_sizing_method: "NONE", # accepts NONE, BASIC
})

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.launch_configuration_template_id #=> String
resp.launch_configuration_template.launch_disposition #=> String, one of "STOPPED", "STARTED"
resp.launch_configuration_template.licensing.os_byol #=> 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"

Parameters:

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

    ({})

Options Hash (params):

  • :copy_private_ip (Boolean) —

    Copy private IP.

  • :copy_tags (Boolean) —

    Copy tags.

  • :launch_configuration_template_id (required, String) —

    Launch Configuration Template ID.

  • :launch_disposition (String) —

    Launch disposition.

  • :licensing (Types::Licensing) —

    Licensing.

  • :target_instance_type_right_sizing_method (String) —

    Target instance type right-sizing method.

Returns:

See Also:



2419
2420
2421
2422
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2419

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



2582
2583
2584
2585
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2582

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



2727
2728
2729
2730
 
# File 'gems/aws-sdk-drs/lib/aws-sdk-drs/client.rb', line 2727

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