software.amazon.awssdk.services.databasemigration.model

Class StartReplicationTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest

software.amazon.awssdk.services.databasemigration.model.StartReplicationTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartReplicationTaskRequest.Builder,StartReplicationTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartReplicationTaskRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<StartReplicationTaskRequest.Builder,StartReplicationTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartReplicationTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartReplicationTaskRequest.Builder	builder()
String	cdcStartPosition() Indicates when you want a change data capture (CDC) operation to start.
Instant	cdcStartTime() Indicates the start time for a change data capture (CDC) operation.
String	cdcStopPosition() Indicates when you want a change data capture (CDC) operation to stop.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	replicationTaskArn() The Amazon Resource Name (ARN) of the replication task to be started.
List<SdkField<?>>	sdkFields()
static Class<? extends StartReplicationTaskRequest.Builder>	serializableBuilderClass()
StartReplicationTaskTypeValue	startReplicationTaskType() The type of replication task to start.
String	startReplicationTaskTypeAsString() The type of replication task to start.
StartReplicationTaskRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

replicationTaskArn

public final String replicationTaskArn()

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

Returns:

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

startReplicationTaskType

public final StartReplicationTaskTypeValue startReplicationTaskType()

The type of replication task to start.

When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. You use reload-target to restart the task and resume-processing to resume the task.

When the migration type is cdc, you use start-replication to start or restart the task, and resume-processing to resume the task. reload-target is not a valid value for a task with migration type of cdc.

If the service returns an enum value that is not available in the current SDK version, startReplicationTaskType will return StartReplicationTaskTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startReplicationTaskTypeAsString().

Returns:

The type of replication task to start.

When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. You use reload-target to restart the task and resume-processing to resume the task.

When the migration type is cdc, you use start-replication to start or restart the task, and resume-processing to resume the task. reload-target is not a valid value for a task with migration type of cdc.

See Also:

StartReplicationTaskTypeValue

startReplicationTaskTypeAsString

public final String startReplicationTaskTypeAsString()

The type of replication task to start.

When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. You use reload-target to restart the task and resume-processing to resume the task.

When the migration type is cdc, you use start-replication to start or restart the task, and resume-processing to resume the task. reload-target is not a valid value for a task with migration type of cdc.

If the service returns an enum value that is not available in the current SDK version, startReplicationTaskType will return StartReplicationTaskTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startReplicationTaskTypeAsString().

Returns:

The type of replication task to start.

When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. You use reload-target to restart the task and resume-processing to resume the task.

When the migration type is cdc, you use start-replication to start or restart the task, and resume-processing to resume the task. reload-target is not a valid value for a task with migration type of cdc.

See Also:

StartReplicationTaskTypeValue

cdcStartTime

public final 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”

Returns:

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”

cdcStartPosition

public final 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.

Returns:

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.

cdcStopPosition

public final 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 “

Returns:

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 “

toBuilder

public StartReplicationTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartReplicationTaskRequest.Builder,StartReplicationTaskRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

builder

public static StartReplicationTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartReplicationTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo