AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dms ]

create-data-migration

Description

Creates a data migration using the provided settings.

See also: AWS API Documentation

Synopsis

  create-data-migration
[--data-migration-name <value>]
--migration-project-identifier <value>
--data-migration-type <value>
--service-access-role-arn <value>
[--enable-cloudwatch-logs | --no-enable-cloudwatch-logs]
[--source-data-settings <value>]
[--number-of-jobs <value>]
[--tags <value>]
[--selection-rules <value>]
[--cli-input-json <value>]
[--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>]

Options

--data-migration-name (string)

A user-friendly name for the data migration. Data migration names have the following constraints:

  • Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
  • Can't end with a hyphen or contain two consecutive hyphens.
  • Length must be from 1 to 255 characters.

--migration-project-identifier (string)

An identifier for the migration project.

--data-migration-type (string)

Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

Possible values:

  • full-load
  • cdc
  • full-load-and-cdc

--service-access-role-arn (string)

The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.

--enable-cloudwatch-logs | --no-enable-cloudwatch-logs (boolean)

Specifies whether to enable CloudWatch logs for the data migration.

--source-data-settings (list)

Specifies information about the source data provider.

(structure)

Defines settings for a source data provider for a data migration.

CDCStartPosition -> (string)

The change data capture (CDC) start position for the source data provider.

CDCStartTime -> (timestamp)

The change data capture (CDC) start time for the source data provider.

CDCStopTime -> (timestamp)

The change data capture (CDC) stop time for the source data provider.

SlotName -> (string)

The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.

Shorthand Syntax:

CDCStartPosition=string,CDCStartTime=timestamp,CDCStopTime=timestamp,SlotName=string ...

JSON Syntax:

[
  {
    "CDCStartPosition": "string",
    "CDCStartTime": timestamp,
    "CDCStopTime": timestamp,
    "SlotName": "string"
  }
  ...
]

--number-of-jobs (integer)

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

--tags (list)

One or more tags to be assigned to the data migration.

(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"
  }
  ...
]

--selection-rules (string)

An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

DataMigration -> (structure)

Information about the created data migration.

DataMigrationName -> (string)

The user-friendly name for the data migration.

DataMigrationArn -> (string)

The Amazon Resource Name (ARN) that identifies this replication.

DataMigrationCreateTime -> (timestamp)

The UTC time when DMS created the data migration.

DataMigrationStartTime -> (timestamp)

The UTC time when DMS started the data migration.

DataMigrationEndTime -> (timestamp)

The UTC time when data migration ended.

ServiceAccessRoleArn -> (string)

The IAM role that the data migration uses to access Amazon Web Services resources.

MigrationProjectArn -> (string)

The Amazon Resource Name (ARN) of the data migration's associated migration project.

DataMigrationType -> (string)

Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

DataMigrationSettings -> (structure)

Specifies CloudWatch settings and selection rules for the data migration.

NumberOfJobs -> (integer)

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

CloudwatchLogsEnabled -> (boolean)

Whether to enable CloudWatch logging for the data migration.

SelectionRules -> (string)

A JSON-formatted string that defines what objects to include and exclude from the migration.

SourceDataSettings -> (list)

Specifies information about the data migration's source data provider.

(structure)

Defines settings for a source data provider for a data migration.

CDCStartPosition -> (string)

The change data capture (CDC) start position for the source data provider.

CDCStartTime -> (timestamp)

The change data capture (CDC) start time for the source data provider.

CDCStopTime -> (timestamp)

The change data capture (CDC) stop time for the source data provider.

SlotName -> (string)

The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.

DataMigrationStatistics -> (structure)

Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

TablesLoaded -> (integer)

The number of tables loaded in the current data migration run.

ElapsedTimeMillis -> (long)

The elapsed duration of the data migration run.

TablesLoading -> (integer)

The data migration's table loading progress.

FullLoadPercentage -> (integer)

The data migration's progress in the full-load migration phase.

CDCLatency -> (integer)

The current latency of the change data capture (CDC) operation.

TablesQueued -> (integer)

The number of tables that are waiting for processing.

TablesErrored -> (integer)

The number of tables that DMS failed to process.

StartTime -> (timestamp)

The time when the migration started.

StopTime -> (timestamp)

The time when the migration stopped or failed.

DataMigrationStatus -> (string)

The current status of the data migration.

PublicIpAddresses -> (list)

The IP addresses of the endpoints for the data migration.

(string)

DataMigrationCidrBlocks -> (list)

The CIDR blocks of the endpoints for the data migration.

(string)

LastFailureMessage -> (string)

Information about the data migration's most recent error or failure.

StopReason -> (string)

The reason the data migration last stopped.