class Aws::Drs::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-drs/client.rb, line 2070 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials 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. @option options [required, String] :region 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` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (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. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("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. @option options [Integer] :client_side_monitoring_port (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. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [String] :defaults_mode ("legacy") See {Aws::DefaultsModeConfiguration} for a list of the accepted modes and the configuration defaults that are included. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint 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. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (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. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (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. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (: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 @option options [Integer] :retry_limit (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. @option options [Integer] :retry_max_delay (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. @option options [String] :retry_mode ("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. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (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. @option options [Boolean] :use_dualstack_endpoint When set to `true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available. @option options [Boolean] :use_fips_endpoint 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`. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Float] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (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. @option options [Float] :http_continue_timeout (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. @option options [Float] :ssl_timeout (nil) Sets the SSL timeout in seconds. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle 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. @option options [String] :ssl_ca_directory 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.
# File lib/aws-sdk-drs/client.rb, line 348 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-drs/client.rb, line 2045 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-drs' context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end
Creates a new ReplicationConfigurationTemplate.
@option params [required, Boolean] :associate_default_security_group
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
@option params [required, Integer] :bandwidth_throttling
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
@option params [required, Boolean] :create_public_ip
Whether to create a Public IP for the Recovery Instance by default.
@option params [required, String] :data_plane_routing
The data plane routing mechanism that will be used for replication.
@option params [required, String] :default_large_staging_disk_type
The Staging Disk EBS volume type to be used during replication.
@option params [required, String] :ebs_encryption
The type of EBS encryption to be used during replication.
@option params [String] :ebs_encryption_key_arn
The ARN of the EBS encryption key to be used during replication.
@option params [required, Array<Types::PITPolicyRule>] :pit_policy
The Point in time (PIT) policy to manage snapshots taken during replication.
@option params [required, String] :replication_server_instance_type
The instance type to be used for the replication server.
@option params [required, Array<String>] :replication_servers_security_groups_i_ds
The security group IDs that will be used by the replication server.
@option params [required, String] :staging_area_subnet_id
The subnet to be used by the replication staging area.
@option params [required, Hash<String,String>] :staging_area_tags
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
@option params [Hash<String,String>] :tags
A set of tags to be associated with the Replication Configuration Template resource.
@option params [required, Boolean] :use_dedicated_replication_server
Whether to use a dedicated Replication Server in the replication staging area.
@return [Types::ReplicationConfigurationTemplate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ReplicationConfigurationTemplate#arn #arn} => String * {Types::ReplicationConfigurationTemplate#associate_default_security_group #associate_default_security_group} => Boolean * {Types::ReplicationConfigurationTemplate#bandwidth_throttling #bandwidth_throttling} => Integer * {Types::ReplicationConfigurationTemplate#create_public_ip #create_public_ip} => Boolean * {Types::ReplicationConfigurationTemplate#data_plane_routing #data_plane_routing} => String * {Types::ReplicationConfigurationTemplate#default_large_staging_disk_type #default_large_staging_disk_type} => String * {Types::ReplicationConfigurationTemplate#ebs_encryption #ebs_encryption} => String * {Types::ReplicationConfigurationTemplate#ebs_encryption_key_arn #ebs_encryption_key_arn} => String * {Types::ReplicationConfigurationTemplate#pit_policy #pit_policy} => Array<Types::PITPolicyRule> * {Types::ReplicationConfigurationTemplate#replication_configuration_template_id #replication_configuration_template_id} => String * {Types::ReplicationConfigurationTemplate#replication_server_instance_type #replication_server_instance_type} => String * {Types::ReplicationConfigurationTemplate#replication_servers_security_groups_i_ds #replication_servers_security_groups_i_ds} => Array<String> * {Types::ReplicationConfigurationTemplate#staging_area_subnet_id #staging_area_subnet_id} => String * {Types::ReplicationConfigurationTemplate#staging_area_tags #staging_area_tags} => Hash<String,String> * {Types::ReplicationConfigurationTemplate#tags #tags} => Hash<String,String> * {Types::ReplicationConfigurationTemplate#use_dedicated_replication_server #use_dedicated_replication_server} => Boolean
@example Request syntax with placeholder values
resp = client.create_replication_configuration_template({ associate_default_security_group: false, # required 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 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 })
@example Response structure
resp.arn #=> String resp.associate_default_security_group #=> 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" 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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/CreateReplicationConfigurationTemplate AWS API Documentation
@overload create_replication_configuration_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 486 def create_replication_configuration_template(params = {}, options = {}) req = build_request(:create_replication_configuration_template, params) req.send_request(options) end
Deletes a single Job by ID.
@option params [required, String] :job_id
The ID of the Job to be deleted.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_job({ job_id: "JobID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DeleteJob AWS API Documentation
@overload delete_job
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 508 def delete_job(params = {}, options = {}) req = build_request(:delete_job, params) req.send_request(options) end
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.
@option params [required, String] :recovery_instance_id
RThe ID of the Recovery Instance to be deleted.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_recovery_instance({ recovery_instance_id: "RecoveryInstanceID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DeleteRecoveryInstance AWS API Documentation
@overload delete_recovery_instance
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 532 def delete_recovery_instance(params = {}, options = {}) req = build_request(:delete_recovery_instance, params) req.send_request(options) end
Deletes a single Replication Configuration Template by ID
@option params [required, String] :replication_configuration_template_id
The ID of the Replication Configuration Template to be deleted.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_replication_configuration_template({ replication_configuration_template_id: "ReplicationConfigurationTemplateID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DeleteReplicationConfigurationTemplate AWS API Documentation
@overload delete_replication_configuration_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 554 def delete_replication_configuration_template(params = {}, options = {}) req = build_request(:delete_replication_configuration_template, params) req.send_request(options) end
Deletes a single Source Server by ID. The Source Server must be disconnected first.
@option params [required, String] :source_server_id
The ID of the Source Server to be deleted.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_source_server({ source_server_id: "SourceServerID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DeleteSourceServer AWS API Documentation
@overload delete_source_server
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 577 def delete_source_server(params = {}, options = {}) req = build_request(:delete_source_server, params) req.send_request(options) end
Retrieves a detailed Job log with pagination.
@option params [required, String] :job_id
The ID of the Job for which Job log items will be retrieved.
@option params [Integer] :max_results
Maximum number of Job log items to retrieve.
@option params [String] :next_token
The token of the next Job log items to retrieve.
@return [Types::DescribeJobLogItemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeJobLogItemsResponse#items #items} => Array<Types::JobLog> * {Types::DescribeJobLogItemsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.describe_job_log_items({ job_id: "JobID", # required max_results: 1, next_token: "PaginationToken", })
@example 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_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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeJobLogItems AWS API Documentation
@overload describe_job_log_items
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 623 def describe_job_log_items(params = {}, options = {}) req = build_request(:describe_job_log_items, params) req.send_request(options) end
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.
@option params [required, Types::DescribeJobsRequestFilters
] :filters
A set of filters by which to return Jobs.
@option params [Integer] :max_results
Maximum number of Jobs to retrieve.
@option params [String] :next_token
The token of the next Job to retrieve.
@return [Types::DescribeJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeJobsResponse#items #items} => Array<Types::Job> * {Types::DescribeJobsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.describe_jobs({ filters: { # required from_date: "ISO8601DatetimeString", job_i_ds: ["JobID"], to_date: "ISO8601DatetimeString", }, max_results: 1, next_token: "PaginationToken", })
@example 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" 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" resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeJobs AWS API Documentation
@overload describe_jobs
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 686 def describe_jobs(params = {}, options = {}) req = build_request(:describe_jobs, params) req.send_request(options) end
Lists all Recovery Instances or multiple Recovery Instances by ID.
@option params [required, Types::DescribeRecoveryInstancesRequestFilters
] :filters
A set of filters by which to return Recovery Instances.
@option params [Integer] :max_results
Maximum number of Recovery Instances to retrieve.
@option params [String] :next_token
The token of the next Recovery Instance to retrieve.
@return [Types::DescribeRecoveryInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeRecoveryInstancesResponse#items #items} => Array<Types::RecoveryInstance> * {Types::DescribeRecoveryInstancesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.describe_recovery_instances({ filters: { # required recovery_instance_i_ds: ["RecoveryInstanceID"], source_server_i_ds: ["SourceServerID"], }, max_results: 1, next_token: "PaginationToken", })
@example 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" 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" 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].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_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" resp.items[0].is_drill #=> Boolean resp.items[0].job_id #=> String 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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeRecoveryInstances AWS API Documentation
@overload describe_recovery_instances
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 782 def describe_recovery_instances(params = {}, options = {}) req = build_request(:describe_recovery_instances, params) req.send_request(options) end
Lists all Recovery Snapshots for a single Source Server.
@option params [Types::DescribeRecoverySnapshotsRequestFilters] :filters
A set of filters by which to return Recovery Snapshots.
@option params [Integer] :max_results
Maximum number of Recovery Snapshots to retrieve.
@option params [String] :next_token
The token of the next Recovery Snapshot to retrieve.
@option params [String] :order
The sorted ordering by which to return Recovery Snapshots.
@option params [required, String] :source_server_id
Filter Recovery Snapshots by Source Server ID.
@return [Types::DescribeRecoverySnapshotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeRecoverySnapshotsResponse#items #items} => Array<Types::RecoverySnapshot> * {Types::DescribeRecoverySnapshotsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example 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 })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeRecoverySnapshots AWS API Documentation
@overload describe_recovery_snapshots
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 839 def describe_recovery_snapshots(params = {}, options = {}) req = build_request(:describe_recovery_snapshots, params) req.send_request(options) end
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
@option params [Integer] :max_results
Maximum number of Replication Configuration Templates to retrieve.
@option params [String] :next_token
The token of the next Replication Configuration Template to retrieve.
@option params [required, Array<String>] :replication_configuration_template_i_ds
The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
@return [Types::DescribeReplicationConfigurationTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeReplicationConfigurationTemplatesResponse#items #items} => Array<Types::ReplicationConfigurationTemplate> * {Types::DescribeReplicationConfigurationTemplatesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.describe_replication_configuration_templates({ max_results: 1, next_token: "PaginationToken", replication_configuration_template_i_ds: ["ReplicationConfigurationTemplateID"], # required })
@example Response structure
resp.items #=> Array resp.items[0].arn #=> String resp.items[0].associate_default_security_group #=> 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" 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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeReplicationConfigurationTemplates AWS API Documentation
@overload describe_replication_configuration_templates
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 905 def describe_replication_configuration_templates(params = {}, options = {}) req = build_request(:describe_replication_configuration_templates, params) req.send_request(options) end
Lists all Source Servers or multiple Source Servers filtered by ID.
@option params [required, Types::DescribeSourceServersRequestFilters
] :filters
A set of filters by which to return Source Servers.
@option params [Integer] :max_results
Maximum number of Source Servers to retrieve.
@option params [String] :next_token
The token of the next Source Server to retrieve.
@return [Types::DescribeSourceServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeSourceServersResponse#items #items} => Array<Types::SourceServer> * {Types::DescribeSourceServersResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.describe_source_servers({ filters: { # required hardware_id: "BoundedString", source_server_i_ds: ["SourceServerID"], }, max_results: 1, next_token: "PaginationToken", })
@example 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].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_seen_by_service_date_time #=> String resp.items[0].recovery_instance_id #=> String resp.items[0].source_properties.cpus #=> Array resp.items[0].source_properties.cpus[0].cores #=> Integer resp.items[0].source_properties.cpus[0].model_name #=> String resp.items[0].source_properties.disks #=> Array resp.items[0].source_properties.disks[0].bytes #=> Integer resp.items[0].source_properties.disks[0].device_name #=> String resp.items[0].source_properties.identification_hints.aws_instance_id #=> String resp.items[0].source_properties.identification_hints.fqdn #=> String resp.items[0].source_properties.identification_hints.hostname #=> String resp.items[0].source_properties.identification_hints.vm_ware_uuid #=> String resp.items[0].source_properties.last_updated_date_time #=> String resp.items[0].source_properties.network_interfaces #=> Array resp.items[0].source_properties.network_interfaces[0].ips #=> Array resp.items[0].source_properties.network_interfaces[0].ips[0] #=> String resp.items[0].source_properties.network_interfaces[0].is_primary #=> Boolean resp.items[0].source_properties.network_interfaces[0].mac_address #=> String resp.items[0].source_properties.os.full_string #=> String resp.items[0].source_properties.ram_bytes #=> Integer resp.items[0].source_properties.recommended_instance_type #=> String resp.items[0].source_server_id #=> String resp.items[0].tags #=> Hash resp.items[0].tags["TagKey"] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeSourceServers AWS API Documentation
@overload describe_source_servers
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 996 def describe_source_servers(params = {}, options = {}) req = build_request(:describe_source_servers, params) req.send_request(options) end
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.
@option params [required, String] :recovery_instance_id
The ID of the Recovery Instance to disconnect.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.disconnect_recovery_instance({ recovery_instance_id: "RecoveryInstanceID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DisconnectRecoveryInstance AWS API Documentation
@overload disconnect_recovery_instance
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1030 def disconnect_recovery_instance(params = {}, options = {}) req = build_request(:disconnect_recovery_instance, params) req.send_request(options) end
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.
@option params [required, String] :source_server_id
The ID of the Source Server to disconnect.
@return [Types::SourceServer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::SourceServer#arn #arn} => String * {Types::SourceServer#data_replication_info #data_replication_info} => Types::DataReplicationInfo * {Types::SourceServer#last_launch_result #last_launch_result} => String * {Types::SourceServer#life_cycle #life_cycle} => Types::LifeCycle * {Types::SourceServer#recovery_instance_id #recovery_instance_id} => String * {Types::SourceServer#source_properties #source_properties} => Types::SourceProperties * {Types::SourceServer#source_server_id #source_server_id} => String * {Types::SourceServer#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.disconnect_source_server({ source_server_id: "SourceServerID", # required })
@example 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.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_seen_by_service_date_time #=> String resp.recovery_instance_id #=> String resp.source_properties.cpus #=> Array resp.source_properties.cpus[0].cores #=> Integer resp.source_properties.cpus[0].model_name #=> String resp.source_properties.disks #=> Array resp.source_properties.disks[0].bytes #=> Integer resp.source_properties.disks[0].device_name #=> String resp.source_properties.identification_hints.aws_instance_id #=> String resp.source_properties.identification_hints.fqdn #=> String resp.source_properties.identification_hints.hostname #=> String resp.source_properties.identification_hints.vm_ware_uuid #=> String resp.source_properties.last_updated_date_time #=> String resp.source_properties.network_interfaces #=> Array resp.source_properties.network_interfaces[0].ips #=> Array resp.source_properties.network_interfaces[0].ips[0] #=> String resp.source_properties.network_interfaces[0].is_primary #=> Boolean resp.source_properties.network_interfaces[0].mac_address #=> String resp.source_properties.os.full_string #=> String resp.source_properties.ram_bytes #=> Integer resp.source_properties.recommended_instance_type #=> String resp.source_server_id #=> String resp.tags #=> Hash resp.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DisconnectSourceServer AWS API Documentation
@overload disconnect_source_server
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1125 def disconnect_source_server(params = {}, options = {}) req = build_request(:disconnect_source_server, params) req.send_request(options) end
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
@option params [required, String] :recovery_instance_id
The ID of the Recovery Instance whose failback replication configuration should be returned.
@return [Types::GetFailbackReplicationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetFailbackReplicationConfigurationResponse#bandwidth_throttling #bandwidth_throttling} => Integer * {Types::GetFailbackReplicationConfigurationResponse#name #name} => String * {Types::GetFailbackReplicationConfigurationResponse#recovery_instance_id #recovery_instance_id} => String * {Types::GetFailbackReplicationConfigurationResponse#use_private_ip #use_private_ip} => Boolean
@example Request syntax with placeholder values
resp = client.get_failback_replication_configuration({ recovery_instance_id: "RecoveryInstanceID", # required })
@example Response structure
resp.bandwidth_throttling #=> Integer resp.name #=> String resp.recovery_instance_id #=> String resp.use_private_ip #=> Boolean
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/GetFailbackReplicationConfiguration AWS API Documentation
@overload get_failback_replication_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1161 def get_failback_replication_configuration(params = {}, options = {}) req = build_request(:get_failback_replication_configuration, params) req.send_request(options) end
Gets a LaunchConfiguration, filtered by Source Server IDs.
@option params [required, String] :source_server_id
The ID of the Source Server that we want to retrieve a Launch Configuration for.
@return [Types::LaunchConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::LaunchConfiguration#copy_private_ip #copy_private_ip} => Boolean * {Types::LaunchConfiguration#copy_tags #copy_tags} => Boolean * {Types::LaunchConfiguration#ec2_launch_template_id #ec2_launch_template_id} => String * {Types::LaunchConfiguration#launch_disposition #launch_disposition} => String * {Types::LaunchConfiguration#licensing #licensing} => Types::Licensing * {Types::LaunchConfiguration#name #name} => String * {Types::LaunchConfiguration#source_server_id #source_server_id} => String * {Types::LaunchConfiguration#target_instance_type_right_sizing_method #target_instance_type_right_sizing_method} => String
@example Request syntax with placeholder values
resp = client.get_launch_configuration({ source_server_id: "SourceServerID", # required })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/GetLaunchConfiguration AWS API Documentation
@overload get_launch_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1204 def get_launch_configuration(params = {}, options = {}) req = build_request(:get_launch_configuration, params) req.send_request(options) end
Gets a ReplicationConfiguration, filtered by Source Server ID.
@option params [required, String] :source_server_id
The ID of the Source Serve for this Replication Configuration.r
@return [Types::ReplicationConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ReplicationConfiguration#associate_default_security_group #associate_default_security_group} => Boolean * {Types::ReplicationConfiguration#bandwidth_throttling #bandwidth_throttling} => Integer * {Types::ReplicationConfiguration#create_public_ip #create_public_ip} => Boolean * {Types::ReplicationConfiguration#data_plane_routing #data_plane_routing} => String * {Types::ReplicationConfiguration#default_large_staging_disk_type #default_large_staging_disk_type} => String * {Types::ReplicationConfiguration#ebs_encryption #ebs_encryption} => String * {Types::ReplicationConfiguration#ebs_encryption_key_arn #ebs_encryption_key_arn} => String * {Types::ReplicationConfiguration#name #name} => String * {Types::ReplicationConfiguration#pit_policy #pit_policy} => Array<Types::PITPolicyRule> * {Types::ReplicationConfiguration#replicated_disks #replicated_disks} => Array<Types::ReplicationConfigurationReplicatedDisk> * {Types::ReplicationConfiguration#replication_server_instance_type #replication_server_instance_type} => String * {Types::ReplicationConfiguration#replication_servers_security_groups_i_ds #replication_servers_security_groups_i_ds} => Array<String> * {Types::ReplicationConfiguration#source_server_id #source_server_id} => String * {Types::ReplicationConfiguration#staging_area_subnet_id #staging_area_subnet_id} => String * {Types::ReplicationConfiguration#staging_area_tags #staging_area_tags} => Hash<String,String> * {Types::ReplicationConfiguration#use_dedicated_replication_server #use_dedicated_replication_server} => Boolean
@example Request syntax with placeholder values
resp = client.get_replication_configuration({ source_server_id: "SourceServerID", # required })
@example Response structure
resp.associate_default_security_group #=> 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" 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].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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/GetReplicationConfiguration AWS API Documentation
@overload get_replication_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1274 def get_replication_configuration(params = {}, options = {}) req = build_request(:get_replication_configuration, params) req.send_request(options) end
Initialize Elastic Disaster Recovery.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/InitializeService AWS API Documentation
@overload initialize_service
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1287 def initialize_service(params = {}, options = {}) req = build_request(:initialize_service, params) req.send_request(options) end
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.
@option params [required, String] :source_server_id
The ID of the Source Server whose data replication should be retried.
@return [Types::SourceServer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::SourceServer#arn #arn} => String * {Types::SourceServer#data_replication_info #data_replication_info} => Types::DataReplicationInfo * {Types::SourceServer#last_launch_result #last_launch_result} => String * {Types::SourceServer#life_cycle #life_cycle} => Types::LifeCycle * {Types::SourceServer#recovery_instance_id #recovery_instance_id} => String * {Types::SourceServer#source_properties #source_properties} => Types::SourceProperties * {Types::SourceServer#source_server_id #source_server_id} => String * {Types::SourceServer#tags #tags} => Hash<String,String>
@example Request syntax with placeholder values
resp = client.retry_data_replication({ source_server_id: "SourceServerID", # required })
@example 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.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_seen_by_service_date_time #=> String resp.recovery_instance_id #=> String resp.source_properties.cpus #=> Array resp.source_properties.cpus[0].cores #=> Integer resp.source_properties.cpus[0].model_name #=> String resp.source_properties.disks #=> Array resp.source_properties.disks[0].bytes #=> Integer resp.source_properties.disks[0].device_name #=> String resp.source_properties.identification_hints.aws_instance_id #=> String resp.source_properties.identification_hints.fqdn #=> String resp.source_properties.identification_hints.hostname #=> String resp.source_properties.identification_hints.vm_ware_uuid #=> String resp.source_properties.last_updated_date_time #=> String resp.source_properties.network_interfaces #=> Array resp.source_properties.network_interfaces[0].ips #=> Array resp.source_properties.network_interfaces[0].ips[0] #=> String resp.source_properties.network_interfaces[0].is_primary #=> Boolean resp.source_properties.network_interfaces[0].mac_address #=> String resp.source_properties.os.full_string #=> String resp.source_properties.ram_bytes #=> Integer resp.source_properties.recommended_instance_type #=> String resp.source_server_id #=> String resp.tags #=> Hash resp.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/RetryDataReplication AWS API Documentation
@overload retry_data_replication
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1401 def retry_data_replication(params = {}, options = {}) req = build_request(:retry_data_replication, params) req.send_request(options) end
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.
@option params [required, Array<String>] :recovery_instance_i_ds
The IDs of the Recovery Instance whose failback launch we want to request.
@option params [Hash<String,String>] :tags
The tags to be associated with the failback launch Job.
@return [Types::StartFailbackLaunchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartFailbackLaunchResponse#job #job} => Types::Job
@example Request syntax with placeholder values
resp = client.start_failback_launch({ recovery_instance_i_ds: ["RecoveryInstanceID"], # required tags: { "TagKey" => "TagValue", }, })
@example 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" 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"
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/StartFailbackLaunch AWS API Documentation
@overload start_failback_launch
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1451 def start_failback_launch(params = {}, options = {}) req = build_request(:start_failback_launch, params) req.send_request(options) end
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.
@option params [Boolean] :is_drill
Whether this Source Server Recovery operation is a drill or not.
@option params [required, Array<Types::StartRecoveryRequestSourceServer>] :source_servers
The Source Servers that we want to start a Recovery Job for.
@option params [Hash<String,String>] :tags
The tags to be associated with the Recovery Job.
@return [Types::StartRecoveryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartRecoveryResponse#job #job} => Types::Job
@example 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", }, })
@example 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" 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"
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/StartRecovery AWS API Documentation
@overload start_recovery
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1508 def start_recovery(params = {}, options = {}) req = build_request(:start_recovery, params) req.send_request(options) end
Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
@option params [required, String] :recovery_instance_id
The ID of the Recovery Instance we want to stop failback for.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.stop_failback({ recovery_instance_id: "RecoveryInstanceID", # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/StopFailback AWS API Documentation
@overload stop_failback
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1532 def stop_failback(params = {}, options = {}) req = build_request(:stop_failback, params) req.send_request(options) end
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.
@option params [required, String] :resource_arn
ARN of the resource for which tags are to be added or updated.
@option params [required, Hash<String,String>] :tags
Array of tags to be added or updated.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "ARN", # required tags: { # required "TagKey" => "TagValue", }, })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1564 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
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.
@option params [required, Array<String>] :recovery_instance_i_ds
The IDs of the Recovery Instances that should be terminated.
@return [Types::TerminateRecoveryInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::TerminateRecoveryInstancesResponse#job #job} => Types::Job
@example Request syntax with placeholder values
resp = client.terminate_recovery_instances({ recovery_instance_i_ds: ["RecoveryInstanceID"], # required })
@example 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" 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"
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/TerminateRecoveryInstances AWS API Documentation
@overload terminate_recovery_instances
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1606 def terminate_recovery_instances(params = {}, options = {}) req = build_request(:terminate_recovery_instances, params) req.send_request(options) end
Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
@option params [required, String] :resource_arn
ARN of the resource for which tags are to be removed.
@option params [required, Array<String>] :tag_keys
Array of tags to be removed.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "ARN", # required tag_keys: ["TagKey"], # required })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1633 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
Allows you to update the failback replication configuration of a Recovery Instance by ID.
@option params [Integer] :bandwidth_throttling
Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
@option params [String] :name
The name of the Failback Replication Configuration.
@option params [required, String] :recovery_instance_id
The ID of the Recovery Instance.
@option params [Boolean] :use_private_ip
Whether to use Private IP for the failback replication of the Recovery Instance.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example 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, })
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/UpdateFailbackReplicationConfiguration AWS API Documentation
@overload update_failback_replication_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1670 def update_failback_replication_configuration(params = {}, options = {}) req = build_request(:update_failback_replication_configuration, params) req.send_request(options) end
Updates a LaunchConfiguration by Source Server ID.
@option params [Boolean] :copy_private_ip
Whether we should copy the Private IP of the Source Server to the Recovery Instance.
@option params [Boolean] :copy_tags
Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
@option params [String] :launch_disposition
The state of the Recovery Instance in EC2 after the recovery operation.
@option params [Types::Licensing] :licensing
The licensing configuration to be used for this launch configuration.
@option params [String] :name
The name of the launch configuration.
@option params [required, String] :source_server_id
The ID of the Source Server that we want to retrieve a Launch Configuration for.
@option params [String] :target_instance_type_right_sizing_method
Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
@return [Types::LaunchConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::LaunchConfiguration#copy_private_ip #copy_private_ip} => Boolean * {Types::LaunchConfiguration#copy_tags #copy_tags} => Boolean * {Types::LaunchConfiguration#ec2_launch_template_id #ec2_launch_template_id} => String * {Types::LaunchConfiguration#launch_disposition #launch_disposition} => String * {Types::LaunchConfiguration#licensing #licensing} => Types::Licensing * {Types::LaunchConfiguration#name #name} => String * {Types::LaunchConfiguration#source_server_id #source_server_id} => String * {Types::LaunchConfiguration#target_instance_type_right_sizing_method #target_instance_type_right_sizing_method} => String
@example 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 })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/UpdateLaunchConfiguration AWS API Documentation
@overload update_launch_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1744 def update_launch_configuration(params = {}, options = {}) req = build_request(:update_launch_configuration, params) req.send_request(options) end
Allows you to update a ReplicationConfiguration by Source Server ID.
@option params [Boolean] :associate_default_security_group
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
@option params [Integer] :bandwidth_throttling
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
@option params [Boolean] :create_public_ip
Whether to create a Public IP for the Recovery Instance by default.
@option params [String] :data_plane_routing
The data plane routing mechanism that will be used for replication.
@option params [String] :default_large_staging_disk_type
The Staging Disk EBS volume type to be used during replication.
@option params [String] :ebs_encryption
The type of EBS encryption to be used during replication.
@option params [String] :ebs_encryption_key_arn
The ARN of the EBS encryption key to be used during replication.
@option params [String] :name
The name of the Replication Configuration.
@option params [Array<Types::PITPolicyRule>] :pit_policy
The Point in time (PIT) policy to manage snapshots taken during replication.
@option params [Array<Types::ReplicationConfigurationReplicatedDisk>] :replicated_disks
The configuration of the disks of the Source Server to be replicated.
@option params [String] :replication_server_instance_type
The instance type to be used for the replication server.
@option params [Array<String>] :replication_servers_security_groups_i_ds
The security group IDs that will be used by the replication server.
@option params [required, String] :source_server_id
The ID of the Source Server for this Replication Configuration.
@option params [String] :staging_area_subnet_id
The subnet to be used by the replication staging area.
@option params [Hash<String,String>] :staging_area_tags
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
@option params [Boolean] :use_dedicated_replication_server
Whether to use a dedicated Replication Server in the replication staging area.
@return [Types::ReplicationConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ReplicationConfiguration#associate_default_security_group #associate_default_security_group} => Boolean * {Types::ReplicationConfiguration#bandwidth_throttling #bandwidth_throttling} => Integer * {Types::ReplicationConfiguration#create_public_ip #create_public_ip} => Boolean * {Types::ReplicationConfiguration#data_plane_routing #data_plane_routing} => String * {Types::ReplicationConfiguration#default_large_staging_disk_type #default_large_staging_disk_type} => String * {Types::ReplicationConfiguration#ebs_encryption #ebs_encryption} => String * {Types::ReplicationConfiguration#ebs_encryption_key_arn #ebs_encryption_key_arn} => String * {Types::ReplicationConfiguration#name #name} => String * {Types::ReplicationConfiguration#pit_policy #pit_policy} => Array<Types::PITPolicyRule> * {Types::ReplicationConfiguration#replicated_disks #replicated_disks} => Array<Types::ReplicationConfigurationReplicatedDisk> * {Types::ReplicationConfiguration#replication_server_instance_type #replication_server_instance_type} => String * {Types::ReplicationConfiguration#replication_servers_security_groups_i_ds #replication_servers_security_groups_i_ds} => Array<String> * {Types::ReplicationConfiguration#source_server_id #source_server_id} => String * {Types::ReplicationConfiguration#staging_area_subnet_id #staging_area_subnet_id} => String * {Types::ReplicationConfiguration#staging_area_tags #staging_area_tags} => Hash<String,String> * {Types::ReplicationConfiguration#use_dedicated_replication_server #use_dedicated_replication_server} => Boolean
@example Request syntax with placeholder values
resp = client.update_replication_configuration({ associate_default_security_group: 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 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, 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, })
@example Response structure
resp.associate_default_security_group #=> 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" 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].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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/UpdateReplicationConfiguration AWS API Documentation
@overload update_replication_configuration
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 1898 def update_replication_configuration(params = {}, options = {}) req = build_request(:update_replication_configuration, params) req.send_request(options) end
Updates a ReplicationConfigurationTemplate by ID.
@option params [String] :arn
The Replication Configuration Template ARN.
@option params [Boolean] :associate_default_security_group
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
@option params [Integer] :bandwidth_throttling
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
@option params [Boolean] :create_public_ip
Whether to create a Public IP for the Recovery Instance by default.
@option params [String] :data_plane_routing
The data plane routing mechanism that will be used for replication.
@option params [String] :default_large_staging_disk_type
The Staging Disk EBS volume type to be used during replication.
@option params [String] :ebs_encryption
The type of EBS encryption to be used during replication.
@option params [String] :ebs_encryption_key_arn
The ARN of the EBS encryption key to be used during replication.
@option params [Array<Types::PITPolicyRule>] :pit_policy
The Point in time (PIT) policy to manage snapshots taken during replication.
@option params [required, String] :replication_configuration_template_id
The Replication Configuration Template ID.
@option params [String] :replication_server_instance_type
The instance type to be used for the replication server.
@option params [Array<String>] :replication_servers_security_groups_i_ds
The security group IDs that will be used by the replication server.
@option params [String] :staging_area_subnet_id
The subnet to be used by the replication staging area.
@option params [Hash<String,String>] :staging_area_tags
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
@option params [Boolean] :use_dedicated_replication_server
Whether to use a dedicated Replication Server in the replication staging area.
@return [Types::ReplicationConfigurationTemplate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ReplicationConfigurationTemplate#arn #arn} => String * {Types::ReplicationConfigurationTemplate#associate_default_security_group #associate_default_security_group} => Boolean * {Types::ReplicationConfigurationTemplate#bandwidth_throttling #bandwidth_throttling} => Integer * {Types::ReplicationConfigurationTemplate#create_public_ip #create_public_ip} => Boolean * {Types::ReplicationConfigurationTemplate#data_plane_routing #data_plane_routing} => String * {Types::ReplicationConfigurationTemplate#default_large_staging_disk_type #default_large_staging_disk_type} => String * {Types::ReplicationConfigurationTemplate#ebs_encryption #ebs_encryption} => String * {Types::ReplicationConfigurationTemplate#ebs_encryption_key_arn #ebs_encryption_key_arn} => String * {Types::ReplicationConfigurationTemplate#pit_policy #pit_policy} => Array<Types::PITPolicyRule> * {Types::ReplicationConfigurationTemplate#replication_configuration_template_id #replication_configuration_template_id} => String * {Types::ReplicationConfigurationTemplate#replication_server_instance_type #replication_server_instance_type} => String * {Types::ReplicationConfigurationTemplate#replication_servers_security_groups_i_ds #replication_servers_security_groups_i_ds} => Array<String> * {Types::ReplicationConfigurationTemplate#staging_area_subnet_id #staging_area_subnet_id} => String * {Types::ReplicationConfigurationTemplate#staging_area_tags #staging_area_tags} => Hash<String,String> * {Types::ReplicationConfigurationTemplate#tags #tags} => Hash<String,String> * {Types::ReplicationConfigurationTemplate#use_dedicated_replication_server #use_dedicated_replication_server} => Boolean
@example Request syntax with placeholder values
resp = client.update_replication_configuration_template({ arn: "ARN", associate_default_security_group: 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 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, })
@example Response structure
resp.arn #=> String resp.associate_default_security_group #=> 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" 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
@see docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/UpdateReplicationConfigurationTemplate AWS API Documentation
@overload update_replication_configuration_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-drs/client.rb, line 2036 def update_replication_configuration_template(params = {}, options = {}) req = build_request(:update_replication_configuration_template, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-drs/client.rb, line 2060 def waiter_names [] end