AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Mgn::Client

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

Overview

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

client = Aws::Mgn::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.
  • :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.

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

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

  • :validate_params (Boolean) — default: true

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

  • :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 (Integer) — 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.

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



324
325
326
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

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

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Examples:

Request syntax with placeholder values


resp = client.change_server_life_cycle_state({
  life_cycle: { # required
    state: "READY_FOR_TEST", # required, accepts READY_FOR_TEST, READY_FOR_CUTOVER, CUTOVER
  },
  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.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :life_cycle (required, Types::ChangeServerLifeCycleStateSourceServerLifecycle)

    The request to change the source server migration lifecycle state.

  • :source_server_id (required, String)

    The request to change the source server migration lifecycle state by source server ID.

Returns:

See Also:



425
426
427
428
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 425

def change_server_life_cycle_state(params = {}, options = {})
  req = build_request(:change_server_life_cycle_state, 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
  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, ST1
  ebs_encryption: "NONE", # required, accepts NONE, DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  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.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", "ST1"
resp.ebs_encryption #=> String, one of "NONE", "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
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)

    Request to associate the default Application Migration Service Security group with the Replication Settings template.

  • :bandwidth_throttling (required, Integer)

    Request to configure bandwidth throttling during Replication Settings template creation.

  • :create_public_ip (required, Boolean)

    Request to create Public IP during Replication Settings template creation.

  • :data_plane_routing (required, String)

    Request to configure data plane routing during Replication Settings template creation.

  • :default_large_staging_disk_type (required, String)

    Request to configure the Staging Disk EBS volume type to "gp2" during Replication Settings template creation.

  • :ebs_encryption (required, String)

    Request to configure EBS enryption during Replication Settings template creation.

  • :ebs_encryption_key_arn (String)

    Request to configure an EBS enryption key during Replication Settings template creation.

  • :replication_server_instance_type (required, String)

    Request to configure the Replication Server instance type during Replication Settings template creation.

  • :replication_servers_security_groups_i_ds (required, Array<String>)

    Request to configure the Replication Server Secuirity group ID during Replication Settings template creation.

  • :staging_area_subnet_id (required, String)

    Request to configure the Staging Area subnet ID during Replication Settings template creation.

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

    Request to configure Staiging Area tags during Replication Settings template creation.

  • :tags (Hash<String,String>)

    Request to configure tags during Replication Settings template creation.

  • :use_dedicated_replication_server (required, Boolean)

    Request to use Dedicated Replication Servers during Replication Settings template creation.

Returns:

See Also:



549
550
551
552
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 549

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)

    Request to delete Job from service by Job ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



571
572
573
574
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 571

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

    Request to delete Replication Configuration Template from service by Replication Configuration Template ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



594
595
596
597
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 594

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.

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)

    Request to delete Source Server from service by Server ID.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



616
617
618
619
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 616

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 detailed Job log with paging.

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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    Request to describe Job log job ID.

  • :max_results (Integer)

    Request to describe Job log item maximum results.

  • :next_token (String)

    Request to describe Job log next token.

Returns:

See Also:



662
663
664
665
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 662

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 toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normaly created by the StartTest, StartCutover, and TerminateTargetInstances 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: { # required
    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_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
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].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

Parameters:

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

    ({})

Options Hash (params):

  • :filters (required, Types::DescribeJobsRequestFilters)

    Request to describe Job log filters.

  • :max_results (Integer)

    Request to describe Job log by max results.

  • :next_token (String)

    Request to describe Job logby next token.

Returns:

See Also:



724
725
726
727
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 724

def describe_jobs(params = {}, options = {})
  req = build_request(:describe_jobs, 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"], # required
})

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", "ST1"
resp.items[0].ebs_encryption #=> String, one of "NONE", "DEFAULT", "CUSTOM"
resp.items[0].ebs_encryption_key_arn #=> String
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)

    Request to describe Replication Configuration template by max results.

  • :next_token (String)

    Request to describe Replication Configuration template by next token.

  • :replication_configuration_template_i_ds (required, Array<String>)

    Request to describe Replication Configuration template by template IDs.

Returns:

See Also:



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

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

Retrieves all SourceServers or multiple SourceServers 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: { # required
    is_archived: false,
    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", "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].is_archived #=> Boolean
resp.items[0].launched_instance.ec2_instance_id #=> String
resp.items[0].launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.items[0].launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.items[0].life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_cutover.initiated.job_id #=> String
resp.items[0].life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.items[0].life_cycle.last_seen_by_service_date_time #=> String
resp.items[0].life_cycle.last_test.finalized.api_call_date_time #=> String
resp.items[0].life_cycle.last_test.initiated.api_call_date_time #=> String
resp.items[0].life_cycle.last_test.initiated.job_id #=> String
resp.items[0].life_cycle.last_test.reverted.api_call_date_time #=> String
resp.items[0].life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :filters (required, Types::DescribeSourceServersRequestFilters)

    Request to filter Source Servers list.

  • :max_results (Integer)

    Request to filter Source Servers list by maximum results.

  • :next_token (String)

    Request to filter Source Servers list by next token.

Returns:

See Also:



883
884
885
886
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 883

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

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

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communciating with the Application Migration Service 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.lagDurationwill be nullified.

Examples:

Request syntax with placeholder values


resp = client.disconnect_from_service({
  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.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_id (required, String)

    Request to disconnect Source Server from service by Server ID.

Returns:

See Also:



986
987
988
989
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 986

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

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

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

Examples:

Request syntax with placeholder values


resp = client.finalize_cutover({
  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.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_id (required, String)

    Request to finalize Cutover by Soure Server ID.

Returns:

See Also:



1088
1089
1090
1091
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1088

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

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

Lists all LaunchConfigurations available, 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)

    Request to get Launch Configuration information by Source Server ID.

Returns:

See Also:



1131
1132
1133
1134
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1131

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

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

Lists all ReplicationConfigurations, 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.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", "ST1"
resp.ebs_encryption #=> String, one of "NONE", "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.name #=> String
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", "IO1", "SC1", "ST1", "STANDARD"
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)

    Request to get Replication Configuaration by Source Server ID.

Returns:

See Also:



1193
1194
1195
1196
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1193

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

#initialize_service(params = {}) ⇒ Struct

Initialize Application Migration Service.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1206
1207
1208
1209
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1206

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

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

List all tags for your Application Migration Service 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)

    List tags for resource request by ARN.

Returns:

See Also:



1235
1236
1237
1238
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1235

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

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

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.

Examples:

Request syntax with placeholder values


resp = client.mark_as_archived({
  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.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_id (required, String)

    Mark as archived by Source Server ID.

Returns:

See Also:



1328
1329
1330
1331
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1328

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

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

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not 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.is_archived #=> Boolean
resp.launched_instance.ec2_instance_id #=> String
resp.launched_instance.first_boot #=> String, one of "WAITING", "SUCCEEDED", "UNKNOWN", "STOPPED"
resp.launched_instance.job_id #=> String
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_cutover.finalized.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.api_call_date_time #=> String
resp.life_cycle.last_cutover.initiated.job_id #=> String
resp.life_cycle.last_cutover.reverted.api_call_date_time #=> String
resp.life_cycle.last_seen_by_service_date_time #=> String
resp.life_cycle.last_test.finalized.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.api_call_date_time #=> String
resp.life_cycle.last_test.initiated.job_id #=> String
resp.life_cycle.last_test.reverted.api_call_date_time #=> String
resp.life_cycle.state #=> String, one of "STOPPED", "NOT_READY", "READY_FOR_TEST", "TESTING", "READY_FOR_CUTOVER", "CUTTING_OVER", "CUTOVER", "DISCONNECTED"
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

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_id (required, String)

    Retry data replication for Source Server ID.

Returns:

See Also:



1421
1422
1423
1424
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1421

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

#start_cutover(params = {}) ⇒ Types::StartCutoverResponse

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

Examples:

Request syntax with placeholder values


resp = client.start_cutover({
  source_server_i_ds: ["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_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
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].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"

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_i_ds (required, Array<String>)

    Start Cutover by Source Server IDs.

  • :tags (Hash<String,String>)

    Start Cutover by Tags.

Returns:

See Also:



1468
1469
1470
1471
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1468

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

#start_test(params = {}) ⇒ Types::StartTestResponse

Lauches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Examples:

Request syntax with placeholder values


resp = client.start_test({
  source_server_i_ds: ["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_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
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].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"

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_i_ds (required, Array<String>)

    Start Test for Source Server IDs.

  • :tags (Hash<String,String>)

    Start Test by Tags.

Returns:

See Also:



1515
1516
1517
1518
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1515

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

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites only the specified tags for the specified Application Migration Service 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)

    Tag resource by ARN.

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

    Tag resource by Tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1547
1548
1549
1550
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1547

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

#terminate_target_instances(params = {}) ⇒ Types::TerminateTargetInstancesResponse

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

Examples:

Request syntax with placeholder values


resp = client.terminate_target_instances({
  source_server_i_ds: ["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_TEST", "START_CUTOVER", "DIAGNOSTIC", "TERMINATE"
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].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"

Parameters:

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

    ({})

Options Hash (params):

  • :source_server_i_ds (required, Array<String>)

    Terminate Target instance by Source Server IDs.

  • :tags (Hash<String,String>)

    Terminate Target instance by Tags.

Returns:

See Also:



1594
1595
1596
1597
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1594

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

#untag_resource(params = {}) ⇒ Struct

Deletes the specified set of tags from the specified set of Application Migration Service 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)

    Untag resource by ARN.

  • :tag_keys (required, Array<String>)

    Untag resource by Keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1621
1622
1623
1624
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1621

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

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

Updates multiple LaunchConfigurations 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)

    Update Launch configuration copy Private IP request.

  • :copy_tags (Boolean)

    Update Launch configuration copy Tags request.

  • :launch_disposition (String)

    Update Launch configuration launch disposition request.

  • :licensing (Types::Licensing)

    Update Launch configuration licensing request.

  • :name (String)

    Update Launch configuration name request.

  • :source_server_id (required, String)

    Update Launch configuration by Source Server ID request.

  • :target_instance_type_right_sizing_method (String)

    Update Launch configuration Target instance right sizing request.

Returns:

See Also:



1689
1690
1691
1692
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1689

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

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

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Examples:

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, ST1
  ebs_encryption: "NONE", # accepts NONE, DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  name: "SmallBoundedString",
  replicated_disks: [
    {
      device_name: "BoundedString",
      iops: 1,
      is_boot_disk: false,
      staging_disk_type: "AUTO", # accepts AUTO, GP2, IO1, SC1, ST1, STANDARD
    },
  ],
  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.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", "ST1"
resp.ebs_encryption #=> String, one of "NONE", "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
resp.name #=> String
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", "IO1", "SC1", "ST1", "STANDARD"
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)

    Update replication configuration associate default Application Migration Service Security group request.

  • :bandwidth_throttling (Integer)

    Update replication configuration bandwidth throttling request.

  • :create_public_ip (Boolean)

    Update replication configuration create Public IP request.

  • :data_plane_routing (String)

    Update replication configuration data plane routing request.

  • :default_large_staging_disk_type (String)

    Update replication configuration use default large Staging Disk type request.

  • :ebs_encryption (String)

    Update replication configuration EBS encryption request.

  • :ebs_encryption_key_arn (String)

    Update replication configuration EBS encryption key ARN request.

  • :name (String)

    Update replication configuration name request.

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

    Update replication configuration replicated disks request.

  • :replication_server_instance_type (String)

    Update replication configuration Replication Server instance type request.

  • :replication_servers_security_groups_i_ds (Array<String>)

    Update replication configuration Replication Server Security Groups IDs request.

  • :source_server_id (required, String)

    Update replication configuration Source Server ID request.

  • :staging_area_subnet_id (String)

    Update replication configuration Staging Area subnet request.

  • :staging_area_tags (Hash<String,String>)

    Update replication configuration Staging Area Tags request.

  • :use_dedicated_replication_server (Boolean)

    Update replication configuration use dedicated Replication Server request.

Returns:

See Also:



1822
1823
1824
1825
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1822

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 multiple ReplicationConfigurationTemplates by ID.

Examples:

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, ST1
  ebs_encryption: "NONE", # accepts NONE, DEFAULT, CUSTOM
  ebs_encryption_key_arn: "ARN",
  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.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", "ST1"
resp.ebs_encryption #=> String, one of "NONE", "DEFAULT", "CUSTOM"
resp.ebs_encryption_key_arn #=> String
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)

    Update replication configuration template ARN request.

  • :associate_default_security_group (Boolean)

    Update replication configuration template associate default Application Migration Service Security group request.

  • :bandwidth_throttling (Integer)

    Update replication configuration template bandwidth throttling request.

  • :create_public_ip (Boolean)

    Update replication configuration template create Public IP request.

  • :data_plane_routing (String)

    Update replication configuration template data plane routing request.

  • :default_large_staging_disk_type (String)

    Update replication configuration template use default large Staging Disk type request.

  • :ebs_encryption (String)

    Update replication configuration template EBS encryption request.

  • :ebs_encryption_key_arn (String)

    Update replication configuration template EBS encryption key ARN request.

  • :replication_configuration_template_id (required, String)

    Update replication configuration template template ID request.

  • :replication_server_instance_type (String)

    Update replication configuration template Replication Server instance type request.

  • :replication_servers_security_groups_i_ds (Array<String>)

    Update replication configuration template Replication Server Security groups IDs request.

  • :staging_area_subnet_id (String)

    Update replication configuration template Staging Area subnet ID request.

  • :staging_area_tags (Hash<String,String>)

    Update replication configuration template Staging Area Tags request.

  • :use_dedicated_replication_server (Boolean)

    Update replication configuration template use dedicated Replication Server request.

Returns:

See Also:



1943
1944
1945
1946
# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/client.rb', line 1943

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