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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.998Z")
 @Stability(value=Stable)
public class CfnReplicationTask
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::ReplicationTask`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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() 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() `AWS::DMS::ReplicationTask.TaskData`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
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	setTargetEndpointArn(String value) An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
void	setTaskData(String value) `AWS::DMS::ReplicationTask.TaskData`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReplicationTask

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

CfnReplicationTask

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

CfnReplicationTask

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

getMigrationType

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

The migration type.

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

setMigrationType

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

The migration type.

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

getReplicationInstanceArn

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

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

setReplicationInstanceArn

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

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

getSourceEndpointArn

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

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

setSourceEndpointArn

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

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

getTableMappings

@Stability(value=Stable)
 @NotNull
public 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 .

setTableMappings

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

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 .

getTargetEndpointArn

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

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

setTargetEndpointArn

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

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

getCdcStartPosition

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

setCdcStartPosition

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

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 .

getCdcStartTime

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

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

setCdcStartTime

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

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

getCdcStopPosition

@Stability(value=Stable)
 @Nullable
public 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"

setCdcStopPosition

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

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"

getReplicationTaskIdentifier

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

setReplicationTaskIdentifier

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

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.

getReplicationTaskSettings

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

setReplicationTaskSettings

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

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 .

getResourceIdentifier

@Stability(value=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.

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 .

setResourceIdentifier

@Stability(value=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.

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 .

getTaskData

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

`AWS::DMS::ReplicationTask.TaskData`.

setTaskData

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

`AWS::DMS::ReplicationTask.TaskData`.