Package software.amazon.awscdk.services.dms

Class CfnReplicationTask

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.dms.CfnReplicationTask
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.410Z") @Stability(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();

  • 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 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 Details

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      One or more tags to be assigned to the replication task.

    • getMigrationType

      @Stability(Stable) @NotNull public String getMigrationType()
      The migration type.

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

    • setMigrationType

      @Stability(Stable) public void setMigrationType(@NotNull String value)
      The migration type.

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

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

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

    • setTableMappings

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

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

      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(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(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(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(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(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(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(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(Stable) @Nullable public String getTaskData()
      AWS::DMS::ReplicationTask.TaskData.

    • setTaskData

      @Stability(Stable) public void setTaskData(@Nullable String value)
      AWS::DMS::ReplicationTask.TaskData.