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

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::CreateReplicationTaskMessage

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cdc_start_position ⇒ String

  Indicates when you want a change data capture (CDC) operation to start.

• #cdc_start_time ⇒ Time

  Indicates the start time for a change data capture (CDC) operation.

• #cdc_stop_position ⇒ String

  Indicates when you want a change data capture (CDC) operation to stop.

• #migration_type ⇒ String

  The migration type.

• #replication_instance_arn ⇒ String

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

• #replication_task_identifier ⇒ String

  An identifier for the replication task.

• #replication_task_settings ⇒ String

  Overall settings for the task, in JSON format.

• #resource_identifier ⇒ String

  A friendly name for the resource identifier at the end of the ‘EndpointArn` response parameter that is returned in the created `Endpoint` object.

• #source_endpoint_arn ⇒ String

  An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

• #table_mappings ⇒ String

  The table mappings for the task, in JSON format.

• #tags ⇒ Array<Types::Tag>

  One or more tags to be assigned to the replication task.

• #target_endpoint_arn ⇒ String

  An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

• #task_data ⇒ String

  Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Instance Attribute Details

#cdc_start_position ⇒ String

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”

<note markdown=“1”> 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 DMS].

</note>

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#cdc_start_time ⇒ Time

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#cdc_stop_position ⇒ String

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#migration_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#replication_instance_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_identifier ⇒ String

An identifier for the replication task.

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_settings ⇒ String

Overall settings for the task, in JSON format. For more information, see [Specifying Task Settings for Database Migration Service Tasks] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ String

A friendly name for the resource identifier at the end of the ‘EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (’-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as ‘Example-App-ARN1`. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don’t specify a ‘ResourceIdentifier` value, DMS generates a default identifier value for the end of `EndpointArn`.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#source_endpoint_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#table_mappings ⇒ String

The table mappings for the task, in JSON format. For more information, see [Using Table Mapping to Specify Task Settings] in the *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

One or more tags to be assigned to the replication task.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#target_endpoint_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#task_data ⇒ String

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][1

in the *Database

Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1765

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,
  :task_data,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end