Class: Aws::DatabaseMigrationService::Types::ReplicationTask

Inherits:

Struct

Object
Struct
Aws::DatabaseMigrationService::Types::ReplicationTask

show all

Includes:: Structure

Defined in:: lib/aws-sdk-databasemigrationservice/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cdc_start_position ⇒ String

Indicates when you want a change data capture (CDC) operation to start.
#cdc_stop_position ⇒ String

Indicates when you want a change data capture (CDC) operation to stop.
#last_failure_message ⇒ String

The last error (failure) message generated for the replication task.
#migration_type ⇒ String

The type of migration.
#recovery_checkpoint ⇒ String

Indicates the last checkpoint that occurred during a change data capture (CDC) operation.
#replication_instance_arn ⇒ String

The ARN of the replication instance.
#replication_task_arn ⇒ String

The Amazon Resource Name (ARN) of the replication task.
#replication_task_creation_date ⇒ Time

The date the replication task was created.
#replication_task_identifier ⇒ String

The user-assigned replication task identifier or name.
#replication_task_settings ⇒ String

The settings for the replication task.
#replication_task_start_date ⇒ Time

The date the replication task is scheduled to start.
#replication_task_stats ⇒ Types::ReplicationTaskStats

The statistics for the task, including elapsed time, tables loaded, and table errors.
#source_endpoint_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
#status ⇒ String

The status of the replication task.
#stop_reason ⇒ String

The reason the replication task was stopped.
#table_mappings ⇒ String

Table mappings specified in the task.
#target_endpoint_arn ⇒ String

The ARN that uniquely identifies the endpoint.
#target_replication_instance_arn ⇒ String

The ARN of the replication instance to which this task is moved in response to running the [ ‘MoveReplicationTask` ][1] operation.
#task_data ⇒ String

Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Instance Attribute Details

#cdc_start_position ⇒ `String`

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”

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cdc_stop_position ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_failure_message ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#migration_type ⇒ `String`

The type of migration.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_checkpoint ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_instance_arn ⇒ `String`

The ARN of the replication instance.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_creation_date ⇒ `Time`

The date the replication task was created.

Returns:

(Time)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_identifier ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_settings ⇒ `String`

The settings for the replication task.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_start_date ⇒ `Time`

The date the replication task is scheduled to start.

Returns:

(Time)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_stats ⇒ `Types::ReplicationTaskStats`

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

Returns:

(Types::ReplicationTaskStats)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source_endpoint_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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>
```

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stop_reason ⇒ `String`

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

‘“Stop Reason NORMAL”`
‘“Stop Reason RECOVERABLE_ERROR”`
‘“Stop Reason FATAL_ERROR”`
‘“Stop Reason FULL_LOAD_ONLY_FINISHED”`
‘“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”`

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#table_mappings ⇒ `String`

Table mappings specified in the task.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#target_endpoint_arn ⇒ `String`

The ARN that uniquely identifies the endpoint.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#target_replication_instance_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

#task_data ⇒ `String`

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]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 11080

class ReplicationTask < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :status,
  :last_failure_message,
  :stop_reason,
  :replication_task_creation_date,
  :replication_task_start_date,
  :cdc_start_position,
  :cdc_stop_position,
  :recovery_checkpoint,
  :replication_task_arn,
  :replication_task_stats,
  :task_data,
  :target_replication_instance_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DatabaseMigrationService::Types::ReplicationTask

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cdc_start_position ⇒ String

#cdc_stop_position ⇒ String

#last_failure_message ⇒ String

#migration_type ⇒ String

#recovery_checkpoint ⇒ String

#replication_instance_arn ⇒ String

#replication_task_arn ⇒ String

#replication_task_creation_date ⇒ Time

#replication_task_identifier ⇒ String

#replication_task_settings ⇒ String

#replication_task_start_date ⇒ Time

#replication_task_stats ⇒ Types::ReplicationTaskStats

#source_endpoint_arn ⇒ String

#status ⇒ String

#stop_reason ⇒ String

#table_mappings ⇒ String

#target_endpoint_arn ⇒ String

#target_replication_instance_arn ⇒ String

#task_data ⇒ String

#cdc_start_position ⇒ `String`

#cdc_stop_position ⇒ `String`

#last_failure_message ⇒ `String`

#migration_type ⇒ `String`

#recovery_checkpoint ⇒ `String`

#replication_instance_arn ⇒ `String`

#replication_task_arn ⇒ `String`

#replication_task_creation_date ⇒ `Time`

#replication_task_identifier ⇒ `String`

#replication_task_settings ⇒ `String`

#replication_task_start_date ⇒ `Time`

#replication_task_stats ⇒ `Types::ReplicationTaskStats`

#source_endpoint_arn ⇒ `String`

#status ⇒ `String`

#stop_reason ⇒ `String`

#table_mappings ⇒ `String`

#target_endpoint_arn ⇒ `String`

#target_replication_instance_arn ⇒ `String`

#task_data ⇒ `String`