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

Class: Aws::DatabaseMigrationService::Types::CreateReplicationTaskMessage

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

{
  replication_task_identifier: "String", # required
  source_endpoint_arn: "String", # required
  target_endpoint_arn: "String", # required
  replication_instance_arn: "String", # required
  migration_type: "full-load", # required, accepts full-load, cdc, full-load-and-cdc
  table_mappings: "String", # required
  replication_task_settings: "String",
  cdc_start_time: Time.now,
  cdc_start_position: "String",
  cdc_stop_position: "String",
  tags: [
    {
      key: "String",
      value: "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)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  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)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  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)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#migration_typeString

The migration type.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#replication_instance_arnString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  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)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#replication_task_settingsString

Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#source_endpoint_arnString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  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)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to be added to the replication instance.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end

#target_endpoint_arnString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 826

class CreateReplicationTaskMessage < Struct.new(
  :replication_task_identifier,
  :source_endpoint_arn,
  :target_endpoint_arn,
  :replication_instance_arn,
  :migration_type,
  :table_mappings,
  :replication_task_settings,
  :cdc_start_time,
  :cdc_start_position,
  :cdc_stop_position,
  :tags)
  include Aws::Structure
end