create-replication-config¶

Description¶

Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

Synopsis¶

  create-replication-config
--replication-config-identifier <value>
--source-endpoint-arn <value>
--target-endpoint-arn <value>
--compute-config <value>
--replication-type <value>
--table-mappings <value>
[--replication-settings <value>]
[--supplemental-settings <value>]
[--resource-identifier <value>]
[--tags <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-config-identifier (string)

A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action. You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.

--source-endpoint-arn (string)

The Amazon Resource Name (ARN) of the source endpoint for this DMS Serverless replication configuration.

--target-endpoint-arn (string)

The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.

--compute-config (structure)

Configuration parameters for provisioning an DMS Serverless replication.

AvailabilityZone -> (string)

The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration’s Amazon Web Services Region, for example, "us-west-2" . You can’t set this parameter if the MultiAZ parameter is set to true .

DnsNameServers -> (string)

A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

KmsKeyId -> (string)

An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication.

If you don’t specify a value for the KmsKeyId parameter, DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

MaxCapacityUnits -> (integer)

Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.

MinCapacityUnits -> (integer)

Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. If you don’t set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits .

MultiAZ -> (boolean)

Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the MultiAZ parameter is set to true .

PreferredMaintenanceWindow -> (string)

The weekly time range during which system maintenance can occur for the DMS Serverless replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi .

The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region. This maintenance occurs on a random day of the week. Valid values for days of the week include Mon , Tue , Wed , Thu , Fri , Sat , and Sun .

Constraints include a minimum 30-minute window.

ReplicationSubnetGroupId -> (string)

Specifies a subnet group identifier to associate with the DMS Serverless replication.

VpcSecurityGroupIds -> (list)

Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.

(string)

Shorthand Syntax:

AvailabilityZone=string,DnsNameServers=string,KmsKeyId=string,MaxCapacityUnits=integer,MinCapacityUnits=integer,MultiAZ=boolean,PreferredMaintenanceWindow=string,ReplicationSubnetGroupId=string,VpcSecurityGroupIds=string,string

JSON Syntax:

{
  "AvailabilityZone": "string",
  "DnsNameServers": "string",
  "KmsKeyId": "string",
  "MaxCapacityUnits": integer,
  "MinCapacityUnits": integer,
  "MultiAZ": true|false,
  "PreferredMaintenanceWindow": "string",
  "ReplicationSubnetGroupId": "string",
  "VpcSecurityGroupIds": ["string", ...]
}

--replication-type (string)

The type of DMS Serverless replication to provision using this replication configuration.

Possible values:

"full-load"

"cdc"

"full-load-and-cdc"

Possible values:

full-load

cdc

full-load-and-cdc

--table-mappings (string)

JSON table mappings for DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON .

--replication-settings (string)

Optional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings .

--supplemental-settings (string)

Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings .

--resource-identifier (string)

Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags .

--tags (list)

One or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service .

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

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

ReplicationConfig -> (structure)

Configuration parameters returned from the DMS Serverless replication after it is created.

ReplicationConfigIdentifier -> (string)

The identifier for the ReplicationConfig associated with the replication.

ReplicationConfigArn -> (string)

The Amazon Resource Name (ARN) of this DMS Serverless replication configuration.

SourceEndpointArn -> (string)

The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.

TargetEndpointArn -> (string)

The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.

ReplicationType -> (string)

The type of the replication.

ComputeConfig -> (structure)

Configuration parameters for provisioning an DMS serverless replication.

AvailabilityZone -> (string)

The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration’s Amazon Web Services Region, for example, "us-west-2" . You can’t set this parameter if the MultiAZ parameter is set to true .

DnsNameServers -> (string)

A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

KmsKeyId -> (string)

An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication.

If you don’t specify a value for the KmsKeyId parameter, DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

MaxCapacityUnits -> (integer)

Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.

MinCapacityUnits -> (integer)

Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. If you don’t set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits .

MultiAZ -> (boolean)

Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the MultiAZ parameter is set to true .

PreferredMaintenanceWindow -> (string)

The weekly time range during which system maintenance can occur for the DMS Serverless replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi .

The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region. This maintenance occurs on a random day of the week. Valid values for days of the week include Mon , Tue , Wed , Thu , Fri , Sat , and Sun .

Constraints include a minimum 30-minute window.

ReplicationSubnetGroupId -> (string)

Specifies a subnet group identifier to associate with the DMS Serverless replication.

VpcSecurityGroupIds -> (list)

Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.

(string)

ReplicationSettings -> (string)

Configuration parameters for an DMS serverless replication.

SupplementalSettings -> (string)

Additional parameters for an DMS serverless replication.

TableMappings -> (string)

Table mappings specified in the replication.

ReplicationConfigCreateTime -> (timestamp)

The time the serverless replication config was created.

ReplicationConfigUpdateTime -> (timestamp)

The time the serverless replication config was updated.

Table of Contents

Feedback

User Guide