software.amazon.awssdk.services.databasemigration.model

Interface CreateReplicationTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>, DatabaseMigrationRequest.Builder, SdkBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateReplicationTaskRequest

public static interface CreateReplicationTaskRequest.Builder
extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<CreateReplicationTaskRequest.Builder,CreateReplicationTaskRequest>

Method Summary

Modifier and Type	Method and Description
CreateReplicationTaskRequest.Builder	cdcStartPosition(String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
CreateReplicationTaskRequest.Builder	cdcStartTime(Instant cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
CreateReplicationTaskRequest.Builder	cdcStopPosition(String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
CreateReplicationTaskRequest.Builder	migrationType(MigrationTypeValue migrationType) The migration type.
CreateReplicationTaskRequest.Builder	migrationType(String migrationType) The migration type.
CreateReplicationTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateReplicationTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateReplicationTaskRequest.Builder	replicationInstanceArn(String replicationInstanceArn) The Amazon Resource Name (ARN) of a replication instance.
CreateReplicationTaskRequest.Builder	replicationTaskIdentifier(String replicationTaskIdentifier) An identifier for the replication task.
CreateReplicationTaskRequest.Builder	replicationTaskSettings(String replicationTaskSettings) Overall settings for the task, in JSON format.
CreateReplicationTaskRequest.Builder	resourceIdentifier(String resourceIdentifier) A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
CreateReplicationTaskRequest.Builder	sourceEndpointArn(String sourceEndpointArn) An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
CreateReplicationTaskRequest.Builder	tableMappings(String tableMappings) The table mappings for the task, in JSON format.
CreateReplicationTaskRequest.Builder	tags(Collection<Tag> tags) One or more tags to be assigned to the replication task.
CreateReplicationTaskRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the replication task.
CreateReplicationTaskRequest.Builder	tags(Tag... tags) One or more tags to be assigned to the replication task.
CreateReplicationTaskRequest.Builder	targetEndpointArn(String targetEndpointArn) An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
CreateReplicationTaskRequest.Builder	taskData(String taskData) Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

replicationTaskIdentifier

CreateReplicationTaskRequest.Builder replicationTaskIdentifier(String replicationTaskIdentifier)

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.

Parameters:

replicationTaskIdentifier - 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:

Returns a reference to this object so that method calls can be chained together.

sourceEndpointArn

CreateReplicationTaskRequest.Builder sourceEndpointArn(String sourceEndpointArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetEndpointArn

CreateReplicationTaskRequest.Builder targetEndpointArn(String targetEndpointArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationInstanceArn

CreateReplicationTaskRequest.Builder replicationInstanceArn(String replicationInstanceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

migrationType

CreateReplicationTaskRequest.Builder migrationType(String migrationType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationTypeValue, MigrationTypeValue

migrationType

CreateReplicationTaskRequest.Builder migrationType(MigrationTypeValue migrationType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationTypeValue, MigrationTypeValue

tableMappings

CreateReplicationTaskRequest.Builder tableMappings(String tableMappings)

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.

Parameters:

tableMappings - 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:

Returns a reference to this object so that method calls can be chained together.

replicationTaskSettings

CreateReplicationTaskRequest.Builder replicationTaskSettings(String replicationTaskSettings)

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.

Parameters:

replicationTaskSettings - 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:

Returns a reference to this object so that method calls can be chained together.

cdcStartTime

CreateReplicationTaskRequest.Builder cdcStartTime(Instant cdcStartTime)

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”

Parameters:

cdcStartTime - 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:

Returns a reference to this object so that method calls can be chained together.

cdcStartPosition

CreateReplicationTaskRequest.Builder cdcStartPosition(String cdcStartPosition)

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.

Parameters:

cdcStartPosition - 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:

Returns a reference to this object so that method calls can be chained together.

cdcStopPosition

CreateReplicationTaskRequest.Builder cdcStopPosition(String cdcStopPosition)

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“

Parameters:

cdcStopPosition - 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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateReplicationTaskRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateReplicationTaskRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateReplicationTaskRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

taskData

CreateReplicationTaskRequest.Builder taskData(String taskData)

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.

Parameters:

taskData - 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:

Returns a reference to this object so that method calls can be chained together.

resourceIdentifier

CreateReplicationTaskRequest.Builder resourceIdentifier(String resourceIdentifier)

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.

Parameters:

resourceIdentifier - 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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateReplicationTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateReplicationTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder