AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DMS::ReplicationTask

CfnReplicationTask

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

Import

import { CfnReplicationTask } from 'aws-cdk-lib/aws-dms';

Or use the module namespace:

import * as dms from 'aws-cdk-lib/aws-dms';
// dms.CfnReplicationTask

Properties

Configuration passed to the constructor as CfnReplicationTaskProps.

migrationTypeRequired
string

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

replicationInstanceArnRequired
string

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

sourceEndpointArnRequired
string

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

tableMappingsRequired
string

The table mappings for the task, in JSON format. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide* .

targetEndpointArnRequired
string

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

cdcStartPositionOptional
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, log sequence number (LSN), or system change number (SCN) format. Here is a date example: `--cdc-start-position "2018-03-08T12:12:12"` Here is a 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"` Here is an LSN example: `--cdc-start-position “mysql-bin-changelog.000024:373”` > 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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .

cdcStartTimeOptional
number

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

cdcStopPositionOptional
string

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"` Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"`

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

replicationTaskSettingsOptional
string

Overall settings for the task, in JSON format. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide* .

resourceIdentifierOptional
string

A display 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, AWS DMS generates a default identifier value for the end of `EndpointArn` .

tagsOptional
CfnTag[]

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

taskDataOptional
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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.*

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter