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 interfaceStartReplicationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartReplicationRequest.Builderbuilder()StringcdcStartPosition()Indicates when you want a change data capture (CDC) operation to start.InstantcdcStartTime()Indicates the start time for a change data capture (CDC) operation.StringcdcStopPosition()Indicates when you want a change data capture (CDC) operation to stop.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringpremigrationAssessmentSettings()User-defined settings for the premigration assessment.StringreplicationConfigArn()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()StringstartReplicationType()The replication type.StartReplicationRequest.BuildertoBuilder()StringtoString()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-loadorfull-load-and-cdc, the only valid value for the first run of the replication isstart-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-processingoption 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-cdcreplication, 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, usereload-target. Otherwise useresume-processing, to replicate the changes from the last stop position.- Returns:
- The replication type.
When the replication type is
full-loadorfull-load-and-cdc, the only valid value for the first run of the replication isstart-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-processingoption 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-cdcreplication, 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, usereload-target. Otherwise useresume-processing, to replicate the changes from the last stop position.
-
premigrationAssessmentSettings
public final String premigrationAssessmentSettings()
User-defined settings for the premigration assessment. The possible values are:
-
ResultLocationFolder: The folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. -
ResultEncryptionMode: The supported values areSSE_KMSandSSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects. -
ResultKmsKeyArn: The ARN of a customer KMS encryption key that you specify when you setResultEncryptionModetoSSE_KMS. -
IncludeOnly: A space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration. -
Exclude: A space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration. -
FailOnAssessmentFailure: A configurable setting you can set totrue(the default setting) orfalse. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.
- Returns:
- User-defined settings for the premigration assessment. The possible values are:
-
ResultLocationFolder: The folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. -
ResultEncryptionMode: The supported values areSSE_KMSandSSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects. -
ResultKmsKeyArn: The ARN of a customer KMS encryption key that you specify when you setResultEncryptionModetoSSE_KMS. -
IncludeOnly: A space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration. -
Exclude: A space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration. -
FailOnAssessmentFailure: A configurable setting you can set totrue(the default setting) orfalse. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.
-
-
-
cdcStartTime
public final Instant cdcStartTime()
Indicates the start time for a change data capture (CDC) operation. Use either
CdcStartTimeorCdcStartPositionto 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
CdcStartTimeorCdcStartPositionto 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
CdcStartPositionorCdcStartTimeto 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
CdcStartPositionorCdcStartTimeto 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:
toBuilderin interfaceToCopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>- Specified by:
toBuilderin classDatabaseMigrationRequest
-
builder
public static StartReplicationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartReplicationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-