Package software.amazon.awssdk.services.databasemigration.model

Interface StartReplicationTaskRequest.Builder

    • Method Detail

      • replicationTaskArn

        StartReplicationTaskRequest.Builder replicationTaskArn​(String replicationTaskArn)

        The Amazon Resource Name (ARN) of the replication task to be started.

        Parameters:
        replicationTaskArn - The Amazon Resource Name (ARN) of the replication task to be started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startReplicationTaskType

        StartReplicationTaskRequest.Builder startReplicationTaskType​(String startReplicationTaskType)

        The type of replication task to start.

        When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

        You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

        The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

        For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

        Parameters:
        startReplicationTaskType - The type of replication task to start.

        When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

        You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

        The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

        For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StartReplicationTaskTypeValue, StartReplicationTaskTypeValue

      • startReplicationTaskType

        StartReplicationTaskRequest.Builder startReplicationTaskType​(StartReplicationTaskTypeValue startReplicationTaskType)

        The type of replication task to start.

        When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

        You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

        The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

        For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

        Parameters:
        startReplicationTaskType - The type of replication task to start.

        When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

        You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

        The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

        For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StartReplicationTaskTypeValue, StartReplicationTaskTypeValue

      • cdcStartTime

        StartReplicationTaskRequest.Builder cdcStartTime​(Instant cdcStartTime)

        Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

        Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

        Parameters:
        cdcStartTime - Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

        Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cdcStartPosition

        StartReplicationTaskRequest.Builder cdcStartPosition​(String cdcStartPosition)

        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, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        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"

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

        Parameters:
        cdcStartPosition - 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, or LSN/SCN format.

        Date Example: --cdc-start-position “2018-03-08T12:12:12”

        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"

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cdcStopPosition

        StartReplicationTaskRequest.Builder cdcStopPosition​(String cdcStopPosition)

        Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

        Parameters:
        cdcStopPosition - Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

        Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

        Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

        Returns:
        Returns a reference to this object so that method calls can be chained together.