Class: Aws::DatabaseMigrationService::Types::ModifyReplicationTaskMessage

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 ModifyReplicationTaskMessage data as a hash:

{
  replication_task_arn: "String", # required
  replication_task_identifier: "String",
  migration_type: "full-load", # accepts full-load, cdc, full-load-and-cdc
  table_mappings: "String",
  replication_task_settings: "String",
  cdc_start_time: Time.now,
  cdc_start_position: "String",
  cdc_stop_position: "String",
  task_data: "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)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  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)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  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)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end

#migration_typeString

The migration type. Valid values: full-load | cdc | full-load-and-cdc

Returns:

  • (String)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_arnString

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

Returns:

  • (String)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_identifierString

The replication task identifier.

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)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_settingsString

JSON file that contains settings for the task, such as task metadata settings.

Returns:

  • (String)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end

#table_mappingsString

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

Returns:

  • (String)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  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 AWS Database Migration Service User Guide.

Returns:

  • (String)


5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5167

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :task_data)
  SENSITIVE = []
  include Aws::Structure
end