MDAA TS Docs
    Preparing search index...

    Interface ReplicationTaskProps

    Configuration for a DMS replication task defining migration settings.

    Use cases: Database migration; Database replication; Data migration workflows; Database connectivity

    AWS: AWS Database Migration Service configuration for database migration and replication

    Validation: Configuration must be valid for deployment; properties must conform to AWS DMS and MDAA requirements

    interface ReplicationTaskProps {
        cdcStartPosition?: string;
        cdcStartTime?: number;
        cdcStopPosition?: string;
        migrationType: DmsMigrationType;
        replicationInstance: string;
        replicationTaskSettings?: { [key: string]: unknown };
        sourceEndpoint: string;
        tableMappings: { [key: string]: unknown };
        targetEndpoint: string;
        taskData?: { [key: string]: unknown };
    }
    Index

    Properties

    cdcStartPosition? cdcStartTime? cdcStopPosition? migrationType replicationInstance replicationTaskSettings? sourceEndpoint tableMappings targetEndpoint taskData?

    Properties

    cdcStartPosition?: string

    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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition

    cdcStartTime?: number

    Indicates the start time for a change data capture (CDC) operation. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime

    cdcStopPosition?: string

    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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition

    migrationType: DmsMigrationType

    The migration type. Valid values: full-load | cdc | full-load-and-cdc See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype

    replicationInstance: string

    Name of the replication instance from the replicationInstances section.

    replicationTaskSettings?: { [key: string]: unknown }

    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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings

    sourceEndpoint: string

    Name of the source endpoint from the endpoints section.

    tableMappings: { [key: string]: unknown }

    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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings

    targetEndpoint: string

    Name of the target endpoint from the endpoints section.

    taskData?: { [key: string]: unknown }

    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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata

    Settings

    Member Visibility

    On This Page

    Properties