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

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

Instance Attribute Summary collapse

Instance Attribute Details

#cdc_start_timeTime

The start time for the Change Data Capture (CDC) operation.

Returns:

  • (Time)


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time)
  include Aws::Structure
end

#migration_typeString

The migration type.

Valid values: full-load | cdc | full-load-and-cdc

Returns:

  • (String)


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time)
  include Aws::Structure
end

#replication_task_arnString

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

Returns:

  • (String)


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time)
  include Aws::Structure
end

#replication_task_identifierString

The replication task identifier.

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)


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time)
  include Aws::Structure
end

#replication_task_settingsString

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

Returns:

  • (String)


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

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


2630
2631
2632
2633
2634
2635
2636
2637
2638
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2630

class ModifyReplicationTaskMessage < Struct.new(
  :replication_task_arn,
  :replication_task_identifier,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time)
  include Aws::Structure
end