ReplicationTask - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ReplicationTask

Provides information that describes a replication task created by the CreateReplicationTask operation.

Contents

CdcStartPosition

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the 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”

Type: String

Required: No

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 “

Type: String

Required: No

LastFailureMessage

The last error (failure) message generated for the replication task.

Type: String

Required: No

MigrationType

The type of migration.

Type: String

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

Required: No

RecoveryCheckpoint

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

Type: String

Required: No

ReplicationInstanceArn

The ARN of the replication instance.

Type: String

Required: No

ReplicationTaskArn

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

Type: String

Required: No

ReplicationTaskCreationDate

The date the replication task was created.

Type: Timestamp

Required: No

ReplicationTaskIdentifier

The user-assigned replication task identifier or name.

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.

Type: String

Required: No

ReplicationTaskSettings

The settings for the replication task.

Type: String

Required: No

ReplicationTaskStartDate

The date the replication task is scheduled to start.

Type: Timestamp

Required: No

ReplicationTaskStats

The statistics for the task, including elapsed time, tables loaded, and table errors.

Type: ReplicationTaskStats object

Required: No

SourceEndpointArn

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

Type: String

Required: No

Status

The status of the replication task. This response parameter can return one of the following values:

Type: String

Required: No

StopReason

The reason the replication task was stopped. This response parameter can return one of the following values:

  • "STOP_REASON_FULL_LOAD_COMPLETED" – Full-load migration completed.

  • "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

  • "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

  • "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

Type: String

Required: No

TableMappings

Table mappings specified in the task.

Type: String

Required: No

TargetEndpointArn

The ARN that uniquely identifies the endpoint.

Type: String

Required: No

TargetReplicationInstanceArn

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Type: String

Required: No

TaskData

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 Amazon Database Migration Service User Guide.

Type: String

Required: No