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

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",
}

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)


3966
3967
3968
3969
3970
3971
3972
3973
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3966

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


3966
3967
3968
3969
3970
3971
3972
3973
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3966

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


3966
3967
3968
3969
3970
3971
3972
3973
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3966

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

#replication_task_arnString

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

Returns:

  • (String)


3966
3967
3968
3969
3970
3971
3972
3973
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3966

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

#start_replication_task_typeString

The type of replication task.

Returns:

  • (String)


3966
3967
3968
3969
3970
3971
3972
3973
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3966

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