class Aws::DatabaseMigrationService::Types::ReplicationTask
Provides information that describes a replication task created by the `CreateReplicationTask` operation.
@!attribute [rw] replication_task_identifier
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. @return [String]
@!attribute [rw] source_endpoint_arn
The Amazon Resource Name (ARN) that uniquely identifies the endpoint. @return [String]
@!attribute [rw] target_endpoint_arn
The ARN that uniquely identifies the endpoint. @return [String]
@!attribute [rw] replication_instance_arn
The ARN of the replication instance. @return [String]
@!attribute [rw] migration_type
The type of migration. @return [String]
@!attribute [rw] table_mappings
Table mappings specified in the task. @return [String]
@!attribute [rw] replication_task_settings
The settings for the replication task. @return [String]
@!attribute [rw] 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 the [ `MoveReplicationTask` ][1] operation. * `"creating"` – The task is being created in response to running the [ `CreateReplicationTask` ][2] operation. * `"deleting"` – The task is being deleted in response to running the [ `DeleteReplicationTask` ][3] operation. * `"failed"` – The task failed to successfully complete the database migration in response to running the [ `StartReplicationTask` ][4] operation. * `"failed-move"` – The task failed to move in response to running the [ `MoveReplicationTask` ][1] operation. * `"modifying"` – The task definition is being modified in response to running the [ `ModifyReplicationTask` ][5] operation. * `"ready"` – The task is in a `ready` state where it can respond to other task operations, such as [ `StartReplicationTask` ][4] or [ `DeleteReplicationTask` ][3]. * `"running"` – The task is performing a database migration in response to running the [ `StartReplicationTask` ][4] operation. * `"starting"` – The task is preparing to perform a database migration in response to running the [ `StartReplicationTask` ][4] operation. * `"stopped"` – The task has stopped in response to running the [ `StopReplicationTask` ][6] operation. * `"stopping"` – The task is preparing to stop in response to running the [ `StopReplicationTask` ][6] operation. * `"testing"` – The database migration specified for this task is being tested in response to running either the [ `StartReplicationTaskAssessmentRun` ][7] or the [ `StartReplicationTaskAssessment` ][8] operation. <note markdown="1"> [ `StartReplicationTaskAssessmentRun` ][7] is an improved premigration task assessment operation. The [ `StartReplicationTaskAssessment` ][8] operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, [ `StartReplicationTaskAssessmentRun` ][7] enables 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. </note> [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html [3]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html [4]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html [5]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html [6]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html [7]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html [8]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html @return [String]
@!attribute [rw] last_failure_message
The last error (failure) message generated for the replication task. @return [String]
@!attribute [rw] stop_reason
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. @return [String]
@!attribute [rw] replication_task_creation_date
The date the replication task was created. @return [Time]
@!attribute [rw] replication_task_start_date
The date the replication task is scheduled to start. @return [Time]
@!attribute [rw] cdc_start_position
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” @return [String]
@!attribute [rw] cdc_stop_position
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 “ @return [String]
@!attribute [rw] recovery_checkpoint
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. @return [String]
@!attribute [rw] replication_task_arn
The Amazon Resource Name (ARN) of the replication task. @return [String]
@!attribute [rw] replication_task_stats
The statistics for the task, including elapsed time, tables loaded, and table errors. @return [Types::ReplicationTaskStats]
@!attribute [rw] task_data
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][1] in the *Database Migration Service User Guide.* [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html @return [String]
@!attribute [rw] target_replication_instance_arn
The ARN of the replication instance to which this task is moved in response to running the [ `MoveReplicationTask` ][1] operation. Otherwise, this response parameter isn't a member of the `ReplicationTask` object. [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/ReplicationTask AWS API Documentation
Constants
- SENSITIVE