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",
      resource_arn: "String",
    },
  ],
  task_data: "String",
  resource_identifier: "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 DMS.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_typeString

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

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_arnString

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

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_identifierString

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)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_settingsString

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.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_identifierString

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)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_arnString

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

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_mappingsString

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.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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

#tagsArray<Types::Tag>

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

Returns:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_arnString

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

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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_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 Database Migration Service User Guide.

Returns:

  • (String)


1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 1478

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