finalize-cutover¶

Description¶

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 changed 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.lagDuration will be nullified.

Synopsis¶

  finalize-cutover
[--account-id <value>]
--source-server-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--account-id (string)

Request to finalize Cutover by Source Account ID.

Constraints:

min: 12

max: 12

pattern: [0-9]{12,}

--source-server-id (string) [required]

Request to finalize Cutover by Source Server ID.

Constraints:

min: 19

max: 19

pattern: ^s-[0-9a-zA-Z]{17}$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

applicationID -> (string)

Source server application ID.

Constraints:

min: 21

max: 21

pattern: ^app-[0-9a-zA-Z]{17}$

arn -> (string)

Source server ARN.

Constraints:

min: 20

max: 2048

connectorAction -> (structure)

Source Server connector action.

connectorArn -> (string)

Source Server connector action connector arn.

Constraints:

min: 27

max: 100

pattern: ^arn:[\w-]+:mgn:([a-z]{2}-(gov-)?[a-z]+-\d{1})?:(\d{12})?:connector\/(connector-[0-9a-zA-Z]{17})$

credentialsSecretArn -> (string)

Source Server connector action credentials secret arn.

Constraints:

min: 20

max: 100

pattern: ^arn:[\w-]+:secretsmanager:([a-z]{2}-(gov-)?[a-z]+-\d{1})?:(\d{12})?:secret:(.+)$

dataReplicationInfo -> (structure)

Source server data replication info.

dataReplicationError -> (structure)

Error in obtaining data replication info.

error -> (string)

Error in data replication.

Possible values:

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

UNSUPPORTED_VM_CONFIGURATION

LAST_SNAPSHOT_JOB_FAILED

rawError -> (string)

Error in data replication.

Constraints:

min: 0

max: 65536

dataReplicationInitiation -> (structure)

Request to query whether data replication has been initiated.

nextAttemptDateTime -> (string)

Request to query next data initiation date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

startDateTime -> (string)

Request to query data initiation start date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

steps -> (list)

Request to query data initiation steps.

(structure)

Data replication initiation step.

name -> (string)

Request to query data initiation step name.

Possible values:

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

status -> (string)

Request to query data initiation status.

Possible values:

NOT_STARTED

IN_PROGRESS

SUCCEEDED

FAILED

SKIPPED

dataReplicationState -> (string)

Request to query the data replication state.

Possible values:

STOPPED

INITIATING

INITIAL_SYNC

BACKLOG

CREATING_SNAPSHOT

CONTINUOUS

PAUSED

RESCAN

STALLED

DISCONNECTED

PENDING_SNAPSHOT_SHIPPING

SHIPPING_SNAPSHOT

etaDateTime -> (string)

Request to query the time when data replication will be complete.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

lagDuration -> (string)

Request to query data replication lag duration.

Constraints:

min: 1

max: 64

lastSnapshotDateTime -> (string)

Request to query data replication last snapshot time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

replicatedDisks -> (list)

Request to query disks replicated.

Constraints:

min: 0

max: 60

(structure)

Request to query disks replicated.

backloggedStorageBytes -> (long)

Request to query data replication backlog size in bytes.

Constraints:

min: 0

deviceName -> (string)

Request to query device name.

Constraints:

min: 0

max: 256

replicatedStorageBytes -> (long)

Request to query amount of data replicated in bytes.

Constraints:

min: 0

rescannedStorageBytes -> (long)

Request to query amount of data rescanned in bytes.

Constraints:

min: 0

totalStorageBytes -> (long)

Request to query total amount of data replicated in bytes.

Constraints:

min: 0

fqdnForActionFramework -> (string)

Source server fqdn for action framework.

Constraints:

min: 0

max: 256

isArchived -> (boolean)

Source server archived status.

launchedInstance -> (structure)

Source server launched instance.

ec2InstanceID -> (string)

Launched instance EC2 ID.

Constraints:

min: 0

max: 255

pattern: ^i-[0-9a-fA-F]{8,}$

firstBoot -> (string)

Launched instance first boot.

Possible values:

WAITING

SUCCEEDED

UNKNOWN

STOPPED

jobID -> (string)

Launched instance Job ID.

Constraints:

min: 24

max: 24

pattern: ^mgnjob-[0-9a-zA-Z]{17}$

lifeCycle -> (structure)

Source server lifecycle state.

addedToServiceDateTime -> (string)

Lifecycle added to service data and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

elapsedReplicationDuration -> (string)

Lifecycle elapsed time and duration.

Constraints:

min: 1

max: 64

firstByteDateTime -> (string)

Lifecycle replication initiation date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

lastCutover -> (structure)

Lifecycle last Cutover.

finalized -> (structure)

Lifecycle Cutover finalized date and time.

apiCallDateTime -> (string)

Lifecycle Cutover finalized date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

initiated -> (structure)

Lifecycle last Cutover initiated.

apiCallDateTime -> (string)

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

jobID -> (string)

Lifecycle last Cutover initiated by Job ID.

Constraints:

min: 24

max: 24

pattern: ^mgnjob-[0-9a-zA-Z]{17}$

reverted -> (structure)

Lifecycle last Cutover reverted.

apiCallDateTime -> (string)

Lifecycle last Cutover reverted API call date time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

lastSeenByServiceDateTime -> (string)

Lifecycle last seen date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

lastTest -> (structure)

Lifecycle last Test.

finalized -> (structure)

Lifecycle last Test finalized.

apiCallDateTime -> (string)

Lifecycle Test failed API call date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

initiated -> (structure)

Lifecycle last Test initiated.

apiCallDateTime -> (string)

Lifecycle last Test initiated API call date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

jobID -> (string)

Lifecycle last Test initiated Job ID.

Constraints:

min: 24

max: 24

pattern: ^mgnjob-[0-9a-zA-Z]{17}$

reverted -> (structure)

Lifecycle last Test reverted.

apiCallDateTime -> (string)

Lifecycle last Test reverted API call date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

state -> (string)

Lifecycle state.

Possible values:

STOPPED

NOT_READY

READY_FOR_TEST

TESTING

READY_FOR_CUTOVER

CUTTING_OVER

CUTOVER

DISCONNECTED

DISCOVERED

PENDING_INSTALLATION

replicationType -> (string)

Source server replication type.

Possible values:

AGENT_BASED

SNAPSHOT_SHIPPING

sourceProperties -> (structure)

Source server properties.

cpus -> (list)

Source Server CPUs.

Constraints:

min: 0

max: 256

(structure)

Source server CPU information.

cores -> (long)

The number of CPU cores on the source server.

Constraints:

min: 0

modelName -> (string)

The source server’s CPU model name.

Constraints:

min: 0

max: 256

disks -> (list)

Source Server disks.

Constraints:

min: 0

max: 1000

(structure)

The disk identifier.

bytes -> (long)

The amount of storage on the disk in bytes.

Constraints:

min: 0

deviceName -> (string)

The disk or device name.

Constraints:

min: 0

max: 256

identificationHints -> (structure)

Source server identification hints.

awsInstanceID -> (string)

AWS Instance ID identification hint.

Constraints:

min: 0

max: 255

pattern: ^i-[0-9a-fA-F]{8,}$

fqdn -> (string)

FQDN address identification hint.

Constraints:

min: 0

max: 256

hostname -> (string)

Hostname identification hint.

Constraints:

min: 0

max: 256

vmPath -> (string)

vCenter VM path identification hint.

Constraints:

min: 0

max: 256

vmWareUuid -> (string)

vmWare UUID identification hint.

Constraints:

min: 0

max: 256

lastUpdatedDateTime -> (string)

Source server last update date and time.

Constraints:

min: 19

max: 32

pattern: ^[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z$

networkInterfaces -> (list)

Source server network interfaces.

Constraints:

min: 0

max: 32

(structure)

Network interface.

ips -> (list)

Network interface IPs.

(string)

Constraints:

min: 0

max: 256

isPrimary -> (boolean)

Network interface primary IP.

macAddress -> (string)

Network interface Mac address.

Constraints:

min: 0

max: 256

os -> (structure)

Source server OS.

fullString -> (string)

OS full string.

Constraints:

min: 0

max: 256

ramBytes -> (long)

Source server RAM in bytes.

Constraints:

min: 0

recommendedInstanceType -> (string)

Source server recommended instance type.

Constraints:

min: 0

max: 255

sourceServerID -> (string)

Source server ID.

Constraints:

min: 19

max: 19

pattern: ^s-[0-9a-zA-Z]{17}$

tags -> (map)

Source server Tags.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 0

max: 256

value -> (string)

Constraints:

min: 0

max: 256

userProvidedID -> (string)

Source server user provided ID.

Constraints:

min: 0

max: 256

vcenterClientID -> (string)

Source server vCenter client id.

Constraints:

min: 21

max: 21

pattern: ^vcc-[0-9a-zA-Z]{17}$

Table of Contents

Feedback

User Guide