Package software.amazon.awssdk.services.databasemigration.model

Class StartReplicationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartReplicationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartReplicationRequest.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	replicationConfigArn()	The Amazon Resource Name of the replication for which to start replication.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartReplicationRequest.Builder>	serializableBuilderClass()
String	startReplicationType()	The replication type.
StartReplicationRequest.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

replicationConfigArn

public final String replicationConfigArn()

The Amazon Resource Name of the replication for which to start replication.

Returns:

The Amazon Resource Name of the replication for which to start replication.

startReplicationType

public final String startReplicationType()

The replication type.

When the replication type is full-load or full-load-and-cdc, the only valid value for the first run of the replication is start-replication. This option will start the replication.

You can also use ReloadTables to reload specific tables that failed during replication instead of restarting the replication.

The resume-processing option isn't applicable for a full-load replication, because you can't resume partially loaded tables during the full load phase.

For a full-load-and-cdc replication, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

Returns:

The replication type.

When the replication type is full-load or full-load-and-cdc, the only valid value for the first run of the replication is start-replication. This option will start the replication.

You can also use ReloadTables to reload specific tables that failed during replication instead of restarting the replication.

The resume-processing option isn't applicable for a full-load replication, because you can't resume partially loaded tables during the full load phase.

For a full-load-and-cdc replication, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

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.

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.

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.

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.

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.

Returns:

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

toBuilder

public StartReplicationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

builder

public static StartReplicationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartReplicationRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo