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) Add an optional request override configuration.
CreateReplicationTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateReplicationTaskRequest.Builder	replicationInstanceArn(String replicationInstanceArn) The Amazon Resource Name (ARN) of the replication instance.
CreateReplicationTaskRequest.Builder	replicationTaskIdentifier(String replicationTaskIdentifier) The replication task identifier.
CreateReplicationTaskRequest.Builder	replicationTaskSettings(String replicationTaskSettings) Settings for the task, such as target metadata settings.
CreateReplicationTaskRequest.Builder	sourceEndpointArn(String sourceEndpointArn) The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
CreateReplicationTaskRequest.Builder	tableMappings(String tableMappings) When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.
CreateReplicationTaskRequest.Builder	tags(Collection<Tag> tags) Tags to be added to the replication instance.
CreateReplicationTaskRequest.Builder	tags(Consumer<Tag.Builder>... tags) Tags to be added to the replication instance.
CreateReplicationTaskRequest.Builder	tags(Tag... tags) Tags to be added to the replication instance.
CreateReplicationTaskRequest.Builder	targetEndpointArn(String targetEndpointArn) The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

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

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)

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.

Parameters:

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

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

sourceEndpointArn

CreateReplicationTaskRequest.Builder sourceEndpointArn(String sourceEndpointArn)

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

Parameters:

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

Returns:

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

targetEndpointArn

CreateReplicationTaskRequest.Builder targetEndpointArn(String targetEndpointArn)

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

Parameters:

targetEndpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the 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 the replication instance.

Parameters:

replicationInstanceArn - The Amazon Resource Name (ARN) of the 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.

Parameters:

migrationType - The migration type.

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.

Parameters:

migrationType - The migration type.

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)

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

Parameters:

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

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

replicationTaskSettings

CreateReplicationTaskRequest.Builder replicationTaskSettings(String replicationTaskSettings)

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 in the AWS Database Migration User Guide.

Parameters:

replicationTaskSettings - 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 in the AWS Database Migration 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”

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”

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:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-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:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-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)

Tags to be added to the replication instance.

Parameters:

tags - Tags to be added to the replication instance.

Returns:

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

tags

CreateReplicationTaskRequest.Builder tags(Tag... tags)

Tags to be added to the replication instance.

Parameters:

tags - Tags to be added to the replication instance.

Returns:

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

tags

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

Tags to be added to the replication instance.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateReplicationTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.