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>

  • Method Details

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

    • 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 are SSE_KMS and SSE_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 set ResultEncryptionMode to SSE_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 to true (the default setting) or false. 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 are SSE_KMS and SSE_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 set ResultEncryptionMode to SSE_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 to true (the default setting) or false. 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 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>
      Specified by:
      toBuilder in class DatabaseMigrationRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.