Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Database Migration Service Resource Types Reference » AWS::DMS::ReplicationTask

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": {
    "CdcStartTime": Timestamp,
    "MigrationType": String,
    "ReplicationInstanceArn": String,
    "ReplicationTaskIdentifier": String,
    "ReplicationTaskSettings": String,
    "SourceEndpointArn": String,
    "TableMappings": String,
    "Tags": [ Resource Tag, ... ],
    "TargetEndpointArn": String
  }
}

YAML

Type: AWS::DMS::ReplicationTask
Properties:
  CdcStartTime: Timestamp
  MigrationType: String
  ReplicationInstanceArn: String
  ReplicationTaskIdentifier: String
  ReplicationTaskSettings: String
  SourceEndpointArn: String
  TableMappings: String
  Tags: 
    - Resource Tag
  TargetEndpointArn: String

Properties

CdcStartTime

The start time for the Change Data Capture (CDC) operation.

Required: No

Type: Number, epoch value in milliseconds

Update requires: No interruption

MigrationType

The migration type.

Valid Values: full-load, cdc, full-load-and-cdc

Required: Yes

Type: String

Update requires: Updates are not supported.

ReplicationInstanceArn

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

Required: Yes

Type: String

Update requires: Replacement

ReplicationTaskIdentifier

The ARN string that uniquely identifies the endpoint.

Required: No

Type: String

Update requires: No interruption

ReplicationTaskSettings

Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide.

Required: No

Type: String

Update requires: No interruption

SourceEndpointArn

The ARN string that uniquely identifies the endpoint.

Required: Yes

Type: String

Update requires: Replacement

TableMappings

The JSON that contains additional parameter values.

Required: Yes

Type: String

Update requires: No interruption

Tags

The tags that you want to attach to the migration task.

Required: No

Type: List of resource tags in key-value format

Update requires: Replacement

TargetEndpointArn

The ARN string that uniquely identifies the endpoint.

Required: Yes

Type: String

Update requires: Replacement

Return Value

Ref

When you pass the logical ID of an AWS::DMS::ReplicationTask resource to the intrinsic Ref function, the function returns the replication task ARN.

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

Example

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:
    Type: AWS::DMS::ReplicationTask
    Properties:
      SourceEndpointArn: !Ref SourceEndpoint
      TargetEndpointArn: !Ref TargetEndpoint
      ReplicationInstanceArn: !Ref ReplicationInstance
      MigrationType: "full-load"
      TableMappings: "{
        \"rules\": [
          {
            \"rule-type\": \"selection\",
            \"rule-id\": \"1\",
            \"rule-name\": \"1\",
            \"object-locator\": {
              \"schema-name\": \"%\",
              \"table-name\": \"%\"
            },
            \"rule-action\": \"include\"
          }
        ]
      }"

See Also