Package software.amazon.awscdk.services.dms

Interface CfnReplicationTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReplicationTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:10.421Z")
@Stability(Stable)
public interface CfnReplicationTaskProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnReplicationTask.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnReplicationTaskProps cfnReplicationTaskProps = CfnReplicationTaskProps.builder()
         .migrationType("migrationType")
         .replicationInstanceArn("replicationInstanceArn")
         .sourceEndpointArn("sourceEndpointArn")
         .tableMappings("tableMappings")
         .targetEndpointArn("targetEndpointArn")
         // the properties below are optional
         .cdcStartPosition("cdcStartPosition")
         .cdcStartTime(123)
         .cdcStopPosition("cdcStopPosition")
         .replicationTaskIdentifier("replicationTaskIdentifier")
         .replicationTaskSettings("replicationTaskSettings")
         .resourceIdentifier("resourceIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskData("taskData")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReplicationTaskProps.Builder	A builder for CfnReplicationTaskProps
static final class	CfnReplicationTaskProps.Jsii$Proxy	An implementation for CfnReplicationTaskProps

Method Summary

Modifier and Type	Method	Description
static CfnReplicationTaskProps.Builder	builder()
default String	getCdcStartPosition()	Indicates when you want a change data capture (CDC) operation to start.
default Number	getCdcStartTime()	Indicates the start time for a change data capture (CDC) operation.
default String	getCdcStopPosition()	Indicates when you want a change data capture (CDC) operation to stop.
String	getMigrationType()	The migration type.
String	getReplicationInstanceArn()	The Amazon Resource Name (ARN) of a replication instance.
default String	getReplicationTaskIdentifier()	An identifier for the replication task.
default String	getReplicationTaskSettings()	Overall settings for the task, in JSON format.
default String	getResourceIdentifier()	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
String	getSourceEndpointArn()	An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
String	getTableMappings()	The table mappings for the task, in JSON format.
default List<CfnTag>	getTags()	One or more tags to be assigned to the replication task.
String	getTargetEndpointArn()	An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
default String	getTaskData()	Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMigrationType

@Stability(Stable)
@NotNull
String getMigrationType()

The migration type.

Valid values: full-load | cdc | full-load-and-cdc

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype

getReplicationInstanceArn

@Stability(Stable)
@NotNull
String getReplicationInstanceArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn

getSourceEndpointArn

@Stability(Stable)
@NotNull
String getSourceEndpointArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn

getTableMappings

@Stability(Stable)
@NotNull
String getTableMappings()

The table mappings for the task, in JSON format.

For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings

getTargetEndpointArn

@Stability(Stable)
@NotNull
String getTargetEndpointArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn

getCdcStartPosition

@Stability(Stable)
@Nullable
default String getCdcStartPosition()

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 in the AWS Database Migration Service User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition

getCdcStartTime

@Stability(Stable)
@Nullable
default Number getCdcStartTime()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime

getCdcStopPosition

@Stability(Stable)
@Nullable
default String getCdcStopPosition()

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"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition

getReplicationTaskIdentifier

@Stability(Stable)
@Nullable
default String getReplicationTaskIdentifier()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier

getReplicationTaskSettings

@Stability(Stable)
@Nullable
default String getReplicationTaskSettings()

Overall settings for the task, in JSON format.

For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings

getResourceIdentifier

@Stability(Stable)
@Nullable
default String getResourceIdentifier()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags

getTaskData

@Stability(Stable)
@Nullable
default String getTaskData()

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 in the AWS Database Migration Service User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata

builder

@Stability(Stable)
static CfnReplicationTaskProps.Builder builder()

Returns:

a CfnReplicationTaskProps.Builder of CfnReplicationTaskProps