Package software.amazon.awscdk.services.dms

Class CfnReplicationTask

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dms.CfnReplicationTask

All Implemented Interfaces:

IInspectable, IReplicationTaskRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.382Z")
@Stability(Stable)
public class CfnReplicationTask
extends CfnResource
implements IInspectable, IReplicationTaskRef, ITaggable

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

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.*;
 CfnReplicationTask cfnReplicationTask = CfnReplicationTask.Builder.create(this, "MyCfnReplicationTask")
         .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	Class	Description
static final class	CfnReplicationTask.Builder	A fluent builder for CfnReplicationTask.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.dms.IReplicationTaskRef

IReplicationTaskRef.Jsii$Default, IReplicationTaskRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef)
	CfnReplicationTask(software.constructs.Construct scope, String id, CfnReplicationTaskProps props)	Create a new AWS::DMS::ReplicationTask.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
String	getCdcStartPosition()	Indicates when you want a change data capture (CDC) operation to start.
Number	getCdcStartTime()	Indicates the start time for a change data capture (CDC) operation.
String	getCdcStopPosition()	Indicates when you want a change data capture (CDC) operation to stop.
protected Map<String,Object>	getCfnProperties()
String	getMigrationType()	The migration type.
String	getReplicationInstanceArn()	The Amazon Resource Name (ARN) of a replication instance.
String	getReplicationTaskIdentifier()	An identifier for the replication task.
ReplicationTaskReference	getReplicationTaskRef()	A reference to a ReplicationTask resource.
String	getReplicationTaskSettings()	Overall settings for the task, in JSON format.
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.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	One or more tags to be assigned to the replication task.
String	getTargetEndpointArn()	An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
String	getTaskData()	Supplemental information that the task requires to migrate the data for certain source and target endpoints.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnReplicationTask(Object x)	Checks whether the given object is a CfnReplicationTask.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCdcStartPosition(String value)	Indicates when you want a change data capture (CDC) operation to start.
void	setCdcStartTime(Number value)	Indicates the start time for a change data capture (CDC) operation.
void	setCdcStopPosition(String value)	Indicates when you want a change data capture (CDC) operation to stop.
void	setMigrationType(String value)	The migration type.
void	setReplicationInstanceArn(String value)	The Amazon Resource Name (ARN) of a replication instance.
void	setReplicationTaskIdentifier(String value)	An identifier for the replication task.
void	setReplicationTaskSettings(String value)	Overall settings for the task, in JSON format.
void	setResourceIdentifier(String value)	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
void	setSourceEndpointArn(String value)	An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
void	setTableMappings(String value)	The table mappings for the task, in JSON format.
void	setTagsRaw(List<CfnTag> value)	One or more tags to be assigned to the replication task.
void	setTargetEndpointArn(String value)	An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
void	setTaskData(String value)	Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnReplicationTask

protected CfnReplicationTask(software.amazon.jsii.JsiiObjectRef objRef)

CfnReplicationTask

protected CfnReplicationTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnReplicationTask

@Stability(Stable)
public CfnReplicationTask(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnReplicationTaskProps props)

Create a new AWS::DMS::ReplicationTask.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnReplicationTask

@Stability(Stable)
@NotNull
public static Boolean isCfnReplicationTask(@NotNull
 Object x)

Checks whether the given object is a CfnReplicationTask.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getReplicationTaskRef

@Stability(Stable)
@NotNull
public ReplicationTaskReference getReplicationTaskRef()

A reference to a ReplicationTask resource.

Specified by:

getReplicationTaskRef in interface IReplicationTaskRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getMigrationType

@Stability(Stable)
@NotNull
public String getMigrationType()

The migration type.

setMigrationType

@Stability(Stable)
public void setMigrationType(@NotNull
 String value)

The migration type.

getReplicationInstanceArn

@Stability(Stable)
@NotNull
public String getReplicationInstanceArn()

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

setReplicationInstanceArn

@Stability(Stable)
public void setReplicationInstanceArn(@NotNull
 String value)

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

getSourceEndpointArn

@Stability(Stable)
@NotNull
public String getSourceEndpointArn()

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

setSourceEndpointArn

@Stability(Stable)
public void setSourceEndpointArn(@NotNull
 String value)

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

getTableMappings

@Stability(Stable)
@NotNull
public String getTableMappings()

The table mappings for the task, in JSON format.

setTableMappings

@Stability(Stable)
public void setTableMappings(@NotNull
 String value)

The table mappings for the task, in JSON format.

getTargetEndpointArn

@Stability(Stable)
@NotNull
public String getTargetEndpointArn()

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

setTargetEndpointArn

@Stability(Stable)
public void setTargetEndpointArn(@NotNull
 String value)

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

getCdcStartPosition

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

Indicates when you want a change data capture (CDC) operation to start.

setCdcStartPosition

@Stability(Stable)
public void setCdcStartPosition(@Nullable
 String value)

Indicates when you want a change data capture (CDC) operation to start.

getCdcStartTime

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

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

setCdcStartTime

@Stability(Stable)
public void setCdcStartTime(@Nullable
 Number value)

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

getCdcStopPosition

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

Indicates when you want a change data capture (CDC) operation to stop.

setCdcStopPosition

@Stability(Stable)
public void setCdcStopPosition(@Nullable
 String value)

Indicates when you want a change data capture (CDC) operation to stop.

getReplicationTaskIdentifier

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

An identifier for the replication task.

setReplicationTaskIdentifier

@Stability(Stable)
public void setReplicationTaskIdentifier(@Nullable
 String value)

An identifier for the replication task.

getReplicationTaskSettings

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

Overall settings for the task, in JSON format.

setReplicationTaskSettings

@Stability(Stable)
public void setReplicationTaskSettings(@Nullable
 String value)

Overall settings for the task, in JSON format.

getResourceIdentifier

@Stability(Stable)
@Nullable
public 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.

setResourceIdentifier

@Stability(Stable)
public void setResourceIdentifier(@Nullable
 String value)

A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

getTaskData

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

Supplemental information that the task requires to migrate the data for certain source and target endpoints.

setTaskData

@Stability(Stable)
public void setTaskData(@Nullable
 String value)

Supplemental information that the task requires to migrate the data for certain source and target endpoints.