software.amazon.awssdk.services.databasemigration.model

Interface ModifyReplicationTaskRequest.Builder

All Superinterfaces:

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

Enclosing class:

ModifyReplicationTaskRequest

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

Method Summary

Modifier and Type	Method and Description
ModifyReplicationTaskRequest.Builder	cdcStartPosition(String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
ModifyReplicationTaskRequest.Builder	cdcStartTime(Instant cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
ModifyReplicationTaskRequest.Builder	cdcStopPosition(String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
ModifyReplicationTaskRequest.Builder	migrationType(MigrationTypeValue migrationType) The migration type.
ModifyReplicationTaskRequest.Builder	migrationType(String migrationType) The migration type.
ModifyReplicationTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ModifyReplicationTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ModifyReplicationTaskRequest.Builder	replicationTaskArn(String replicationTaskArn) The Amazon Resource Name (ARN) of the replication task.
ModifyReplicationTaskRequest.Builder	replicationTaskIdentifier(String replicationTaskIdentifier) The replication task identifier.
ModifyReplicationTaskRequest.Builder	replicationTaskSettings(String replicationTaskSettings) JSON file that contains settings for the task, such as target metadata settings.
ModifyReplicationTaskRequest.Builder	tableMappings(String tableMappings) When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings.

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

replicationTaskArn

ModifyReplicationTaskRequest.Builder replicationTaskArn(String replicationTaskArn)

The Amazon Resource Name (ARN) of the replication task.

Parameters:

replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

Returns:

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

replicationTaskIdentifier

ModifyReplicationTaskRequest.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.

migrationType

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.Builder replicationTaskSettings(String replicationTaskSettings)

JSON file that contains settings for the task, such as target metadata settings.

Parameters:

replicationTaskSettings - JSON file that contains settings for the task, such as target metadata settings.

Returns:

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

cdcStartTime

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.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.

overrideConfiguration

ModifyReplicationTaskRequest.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

ModifyReplicationTaskRequest.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.