AWS CloudFormation
User Guide (Version )

AWS::DMS::ReplicationTask

The AWS::DMS::ReplicationTask resource creates an AWS DMS replication task.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::DMS::ReplicationTask", "Properties" : { "CdcStartPosition" : String, "CdcStartTime" : Double, "CdcStopPosition" : String, "MigrationType" : String, "ReplicationInstanceArn" : String, "ReplicationTaskIdentifier" : String, "ReplicationTaskSettings" : String, "SourceEndpointArn" : String, "TableMappings" : String, "Tags" : [ Tag, ... ], "TargetEndpointArn" : String } }

YAML

Type: AWS::DMS::ReplicationTask Properties: CdcStartPosition: String CdcStartTime: Double CdcStopPosition: String MigrationType: String ReplicationInstanceArn: String ReplicationTaskIdentifier: String ReplicationTaskSettings: String SourceEndpointArn: String TableMappings: String Tags: - Tag TargetEndpointArn: String

Properties

CdcStartPosition

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

Required: No

Type: String

Update requires: No interruption

CdcStartTime

Indicates the start time for a change data capture (CDC) operation.

Required: No

Type: Double

Update requires: No interruption

CdcStopPosition

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:3018-02-09T12:12:12”

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

Required: No

Type: String

Update requires: No interruption

MigrationType

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

Required: Yes

Type: String

Allowed Values: cdc | full-load | full-load-and-cdc

Update requires: No interruption

ReplicationInstanceArn

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

Required: Yes

Type: String

Update requires: Replacement

ReplicationTaskIdentifier

An identifier for the replication task.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Required: No

Type: String

Update requires: No interruption

ReplicationTaskSettings

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

Required: No

Type: String

Update requires: No interruption

SourceEndpointArn

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

Required: Yes

Type: String

Update requires: Replacement

TableMappings

The table mappings for the task, in JSON format. For more information, see Table Mapping in the AWS Database Migration User Guide.

Required: Yes

Type: String

Update requires: No interruption

Tags

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

Required: No

Type: List of Tag

Update requires: Replacement

TargetEndpointArn

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

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the replication task ARN.

For more information about using the Ref function, see Ref.

Examples

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "myReplicationTask": { "Type": "AWS::DMS::ReplicationTask", "Properties": { "SourceEndpointArn": 11, "TargetEndpointArn": "12ff", "ReplicationInstanceArn": "ert1", "MigrationType": "full-load", "TableMappings": "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }" } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Resources: myReplicationTask: Properties: MigrationType: full-load ReplicationInstanceArn: ReplicationInstance SourceEndpointArn: SourceEndpoint TableMappings: "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }" TargetEndpointArn: TargetEndpoint Type: "AWS::DMS::ReplicationTask"

See Also