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("software.amazon.awssdk:codegen") public final class StartReplicationTaskRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<StartReplicationTaskRequest.Builder,StartReplicationTaskRequest>

  • Method Details

    • 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. This option will start the migration.

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

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

      For a full-load-and-cdc task, 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.

      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. This option will start the migration.

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

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

      For a full-load-and-cdc task, 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.

      See Also:

    • 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. This option will start the migration.

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

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

      For a full-load-and-cdc task, 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.

      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. This option will start the migration.

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

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

      For a full-load-and-cdc task, 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.

      See Also:

    • 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()
      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<StartReplicationTaskRequest.Builder,StartReplicationTaskRequest>
      Specified by:
      toBuilder in class DatabaseMigrationRequest
      Returns:
      a builder for type T

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