AWS CLI Command Reference

[ aws . dms ]

create-replication-task

Description

Creates a replication task using the specified parameters.

See also: AWS API Documentation

Synopsis

  create-replication-task
--replication-task-identifier <value>
--source-endpoint-arn <value>
--target-endpoint-arn <value>
--replication-instance-arn <value>
--migration-type <value>
--table-mappings <value>
[--replication-task-settings <value>]
[--cdc-start-time <value>]
[--cdc-start-position <value>]
[--cdc-stop-position <value>]
[--tags <value>]
[--task-data <value>]
[--resource-identifier <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

--replication-task-identifier (string)

An identifier for the replication task.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

--source-endpoint-arn (string)

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

--target-endpoint-arn (string)

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

--replication-instance-arn (string)

The Amazon Resource Name (ARN) of a replication instance.

--migration-type (string)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Possible values:

  • full-load

  • cdc

  • full-load-and-cdc

--table-mappings (string)

The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.

--replication-task-settings (string)

Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.

--cdc-start-time (timestamp)

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”

--cdc-start-position (string)

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

Note

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS .

--cdc-stop-position (string)

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

--tags (list)

One or more tags to be assigned to the replication task.

(structure)

A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

  • AddTagsToResource

  • ListTagsForResource

  • RemoveTagsFromResource

Key -> (string)

A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Value -> (string)

A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

ResourceArn -> (string)

The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

Shorthand Syntax:

Key=string,Value=string,ResourceArn=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string",
    "ResourceArn": "string"
  }
  ...
]

--task-data (string)

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

--resource-identifier (string)

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 . For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don’t specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn .

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

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a replication task

The following create-replication-task example creates a replication task.

aws dms create-replication-task \
    --replication-task-identifier movedata \
    --source-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \
    --target-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U \
    --replication-instance-arn $RI_ARN \
    --migration-type full-load \
    --table-mappings file://table-mappings.json

Contents of table-mappings.json:

{
    "rules": [
        {
            "rule-type": "selection",
            "rule-id": "1",
            "rule-name": "1",
            "object-locator": {
                "schema-name": "prodrep",
                "table-name": "%"
            },
            "rule-action": "include",
            "filters": []
        }
    ]
}

Output:

{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted... ,
        "ReplicationTaskSettings": ...output omitted... ,
        "Status": "creating",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

For more information, see Working with AWS DMS Tasks in the AWS Database Migration Service User Guide.

Output

ReplicationTask -> (structure)

The replication task that was created.

ReplicationTaskIdentifier -> (string)

The user-assigned replication task identifier or name.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

SourceEndpointArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the endpoint.

TargetEndpointArn -> (string)

The ARN that uniquely identifies the endpoint.

ReplicationInstanceArn -> (string)

The ARN of the replication instance.

MigrationType -> (string)

The type of migration.

TableMappings -> (string)

Table mappings specified in the task.

ReplicationTaskSettings -> (string)

The settings for the replication task.

Status -> (string)

The status of the replication task. This response parameter can return one of the following values:

Note

` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ is an improved premigration task assessment operation. The ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.

LastFailureMessage -> (string)

The last error (failure) message generated for the replication task.

StopReason -> (string)

The reason the replication task was stopped. This response parameter can return one of the following values:

  • "Stop Reason NORMAL"

  • "Stop Reason RECOVERABLE_ERROR"

  • "Stop Reason FATAL_ERROR"

  • "Stop Reason FULL_LOAD_ONLY_FINISHED"

  • "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied

  • "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied

  • "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"

  • "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied

  • "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"

  • "Stop Reason STOPPED_DUE_TO_LOW_DISK"

  • "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task

  • "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task

  • "Stop Reason RECONFIGURATION_RESTART"

  • "Stop Reason RECYCLE_TASK"

ReplicationTaskCreationDate -> (timestamp)

The date the replication task was created.

ReplicationTaskStartDate -> (timestamp)

The date the replication task is scheduled to start.

CdcStartPosition -> (string)

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

CdcStopPosition -> (string)

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

RecoveryCheckpoint -> (string)

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

ReplicationTaskArn -> (string)

The Amazon Resource Name (ARN) of the replication task.

ReplicationTaskStats -> (structure)

The statistics for the task, including elapsed time, tables loaded, and table errors.

FullLoadProgressPercent -> (integer)

The percent complete for the full load migration task.

ElapsedTimeMillis -> (long)

The elapsed time of the task, in milliseconds.

TablesLoaded -> (integer)

The number of tables loaded for this task.

TablesLoading -> (integer)

The number of tables currently loading for this task.

TablesQueued -> (integer)

The number of tables queued for this task.

TablesErrored -> (integer)

The number of errors that have occurred during this task.

FreshStartDate -> (timestamp)

The date the replication task was started either with a fresh start or a target reload.

StartDate -> (timestamp)

The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType .

StopDate -> (timestamp)

The date the replication task was stopped.

FullLoadStartDate -> (timestamp)

The date the replication task full load was started.

FullLoadFinishDate -> (timestamp)

The date the replication task full load was completed.

TaskData -> (string)

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

TargetReplicationInstanceArn -> (string)

The ARN of the replication instance to which this task is moved in response to running the ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ operation. Otherwise, this response parameter isn’t a member of the ReplicationTask object.

© Copyright 2018, Amazon Web Services. Created using Sphinx.