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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/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

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


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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

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

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_messageString

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

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_typeString

The type of migration.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_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)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_arnString

The ARN of the replication instance.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_arnString

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

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_dateTime

The date the replication task was created.

Returns:

  • (Time)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_identifierString

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)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_settingsString

The settings for the replication task.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_dateTime

The date the replication task is scheduled to start.

Returns:

  • (Time)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_statsTypes::ReplicationTaskStats

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



8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_arnString

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

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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

#statusString

The status of the replication task. This response parameter can return one of the following values:

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_reasonString

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.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_mappingsString

Table mappings specified in the task.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_arnString

The ARN that uniquely identifies the endpoint.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_arnString

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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_dataString

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 Database Migration Service User Guide.

Returns:

  • (String)


8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8054

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