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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateReplicationTaskMessage as input to an Aws::Client method, you can use a vanilla 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”

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)

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

#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)

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

#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)

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

#migration_typeString

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

Possible values:

  • full-load
  • cdc
  • full-load-and-cdc

Returns:

  • (String)

    The migration type.

#replication_instance_arnString

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

Returns:

  • (String)

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

#replication_task_identifierString

An identifier for the replication task.

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)

    An identifier for the replication task.

#replication_task_settingsString

Overall settings for the task, in JSON format. For more information, see Task Settings in the AWS Database Migration User Guide.

Returns:

  • (String)

    Overall settings for the task, in JSON format.

#source_endpoint_arnString

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

Returns:

  • (String)

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

#table_mappingsString

The table mappings for the task, in JSON format. For more information, see Table Mapping in the AWS Database Migration User Guide.

Returns:

  • (String)

    The table mappings for the task, in JSON format.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

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

#target_endpoint_arnString

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

Returns:

  • (String)

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