Class: Aws::DatabaseMigrationService::Types::StartReplicationTaskMessage

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

Overview

Note:

When making an API call, you may pass StartReplicationTaskMessage data as a hash:

{
  replication_task_arn: "String", # required
  start_replication_task_type: "start-replication", # required, accepts start-replication, resume-processing, reload-target
  cdc_start_time: Time.now,
  cdc_start_position: "String",
  cdc_stop_position: "String",
}

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

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

Returns:

  • (String)


8170
8171
8172
8173
8174
8175
8176
8177
8178
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8170

class StartReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :start_replication_task_type,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position)
  SENSITIVE = []
  include Aws::Structure
end

#cdc_start_timeTime

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Returns:

  • (Time)


8170
8171
8172
8173
8174
8175
8176
8177
8178
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8170

class StartReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :start_replication_task_type,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position)
  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)


8170
8171
8172
8173
8174
8175
8176
8177
8178
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8170

class StartReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :start_replication_task_type,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_arnString

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

Returns:

  • (String)


8170
8171
8172
8173
8174
8175
8176
8177
8178
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8170

class StartReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :start_replication_task_type,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position)
  SENSITIVE = []
  include Aws::Structure
end

#start_replication_task_typeString

A type of replication task.

Returns:

  • (String)


8170
8171
8172
8173
8174
8175
8176
8177
8178
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8170

class StartReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :start_replication_task_type,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position)
  SENSITIVE = []
  include Aws::Structure
end