NAME

Paws::DMS::ReplicationTask

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DMS::ReplicationTask object:

$service_obj->Method(Att1 => { CdcStartPosition => $value, ..., TaskData => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::ReplicationTask object:

$result = $service_obj->Method(...);
$result->Att1->CdcStartPosition

DESCRIPTION

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

ATTRIBUTES

CdcStartPosition => Str

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”

CdcStopPosition => Str

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 “

LastFailureMessage => Str

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

MigrationType => Str

The type of migration.

RecoveryCheckpoint => Str

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.

ReplicationInstanceArn => Str

The ARN of the replication instance.

ReplicationTaskArn => Str

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

ReplicationTaskCreationDate => Str

The date the replication task was created.

ReplicationTaskIdentifier => Str

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.

ReplicationTaskSettings => Str

The settings for the replication task.

ReplicationTaskStartDate => Str

The date the replication task is scheduled to start.

ReplicationTaskStats => Paws::DMS::ReplicationTaskStats

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

SourceEndpointArn => Str

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

Status => Str

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 (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) operation.

  • "creating" – The task is being created in response to running the CreateReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) operation.

  • "deleting" – The task is being deleted in response to running the DeleteReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html) operation.

  • "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) operation.

  • "failed-move" – The task failed to move in response to running the MoveReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) operation.

  • "modifying" – The task definition is being modified in response to running the ModifyReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) operation.

  • "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) or DeleteReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html).

  • "running" – The task is performing a database migration in response to running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) operation.

  • "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) operation.

  • "stopped" – The task has stopped in response to running the StopReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) operation.

  • "stopping" – The task is preparing to stop in response to running the StopReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) operation.

  • "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) or the StartReplicationTaskAssessment (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) operation.

    StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) is an improved premigration task assessment operation. The StartReplicationTaskAssessment (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) 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.

StopReason => Str

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.

TableMappings => Str

Table mappings specified in the task.

TargetEndpointArn => Str

The ARN that uniquely identifies the endpoint.

TargetReplicationInstanceArn => Str

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

TaskData => Str

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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the AWS Database Migration Service User Guide.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::DMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues