You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cdc_start_positionString

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


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#cdc_stop_positionString

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:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#last_failure_messageString

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

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#migration_typeString

The type of migration.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#recovery_checkpointString

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)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_instance_arnString

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

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_arnString

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

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_creation_dateTime

The date the replication task was created.

Returns:

  • (Time)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_identifierString

The user-assigned replication task identifier or name.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_settingsString

The settings for the replication task.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_start_dateTime

The date the replication task is scheduled to start.

Returns:

  • (Time)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#replication_task_statsTypes::ReplicationTaskStats

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



3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#source_endpoint_arnString

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

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#statusString

The status of the replication task.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#stop_reasonString

The reason the replication task was stopped.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#table_mappingsString

Table mappings specified in the task.

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end

#target_endpoint_arnString

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

Returns:

  • (String)


3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3874

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)
  include Aws::Structure
end