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)
ModifyReplicationTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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 task metadata settings.
ModifyReplicationTaskRequest.Builder	tableMappings(String tableMappings) When using the CLI or boto3, provide the path of the JSON file that contains the table mappings.
ModifyReplicationTaskRequest.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

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

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 CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.

Parameters:

tableMappings - When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.

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 task metadata settings.

Parameters:

replicationTaskSettings - JSON file that contains settings for the task, such as task 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”

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

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

taskData

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

overrideConfiguration

ModifyReplicationTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder