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
CdcStartPositionorCdcStartTimeto 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-cdcRequired: No
- RecoveryCheckpoint
-
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the
CdcStartPositionparameter 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:
-
"moving"– The task is being moved in response to running theMoveReplicationTaskoperation. -
"creating"– The task is being created in response to running theCreateReplicationTaskoperation. -
"deleting"– The task is being deleted in response to running theDeleteReplicationTaskoperation. -
"failed"– The task failed to successfully complete the database migration in response to running theStartReplicationTaskoperation. -
"failed-move"– The task failed to move in response to running theMoveReplicationTaskoperation. -
"modifying"– The task definition is being modified in response to running theModifyReplicationTaskoperation. -
"ready"– The task is in areadystate where it can respond to other task operations, such asStartReplicationTaskorDeleteReplicationTask. -
"running"– The task is performing a database migration in response to running theStartReplicationTaskoperation. -
"starting"– The task is preparing to perform a database migration in response to running theStartReplicationTaskoperation. -
"stopped"– The task has stopped in response to running theStopReplicationTaskoperation. -
"stopping"– The task is preparing to stop in response to running theStopReplicationTaskoperation. -
"testing"– The database migration specified for this task is being tested in response to running either theStartReplicationTaskAssessmentRunor theStartReplicationTaskAssessmentoperation.Note
StartReplicationTaskAssessmentRunis an improved premigration task assessment operation. TheStartReplicationTaskAssessmentoperation assesses data type compatibility only between the source and target database of a given migration task. In contrast,StartReplicationTaskAssessmentRunenables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
Type: String
Required: No
-
- StopReason
-
The reason the replication task was stopped. This response parameter can return one of the following values:
-
"Stop Reason NORMAL"– The task completed successfully with no additional information returned. -
"Stop Reason RECOVERABLE_ERROR" -
"Stop Reason FATAL_ERROR" -
"Stop Reason FULL_LOAD_ONLY_FINISHED"– The task completed the full load phase. DMS applied cached changes if you setStopTaskCachedChangesAppliedtotrue. -
"Stop Reason STOPPED_AFTER_FULL_LOAD"– Full load completed, with cached changes not applied -
"Stop Reason STOPPED_AFTER_CACHED_EVENTS"– Full load completed, with cached changes applied -
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED" -
"Stop Reason STOPPED_AFTER_DDL_APPLY"– User-defined stop task after DDL applied -
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY" -
"Stop Reason STOPPED_DUE_TO_LOW_DISK" -
"Stop Reason STOPPED_AT_SERVER_TIME"– User-defined server time for stopping task -
"Stop Reason STOPPED_AT_COMMIT_TIME"– User-defined commit time for stopping task -
"Stop Reason RECONFIGURATION_RESTART" -
"Stop Reason RECYCLE_TASK"
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
MoveReplicationTaskoperation. Otherwise, this response parameter isn't a member of theReplicationTaskobject.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 AWS Database Migration Service User Guide.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
