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.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.413Z") @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();

  • Method Details

    • getMigrationType

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

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

    • getReplicationInstanceArn

      @Stability(Stable) @NotNull String getReplicationInstanceArn()
      The Amazon Resource Name (ARN) of a replication instance.

    • getSourceEndpointArn

      @Stability(Stable) @NotNull String getSourceEndpointArn()
      An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

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

    • getTargetEndpointArn

      @Stability(Stable) @NotNull String getTargetEndpointArn()
      An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

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

    • getCdcStartTime

      @Stability(Stable) @Nullable default Number getCdcStartTime()
      Indicates the start time for a change data capture (CDC) operation.

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

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

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

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

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      One or more tags to be assigned to the replication task.

    • getTaskData

      @Stability(Stable) @Nullable default String getTaskData()
      AWS::DMS::ReplicationTask.TaskData.

    • builder

      @Stability(Stable) static CfnReplicationTaskProps.Builder builder()
      Returns:
      a CfnReplicationTaskProps.Builder of CfnReplicationTaskProps