Interface StartReplicationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>, DatabaseMigrationRequest.Builder, SdkBuilder<StartReplicationRequest.Builder,StartReplicationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartReplicationRequest
@Mutable @NotThreadSafe public static interface StartReplicationRequest.Builder extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<StartReplicationRequest.Builder,StartReplicationRequest>

  • Method Details

    • replicationConfigArn

      StartReplicationRequest.Builder replicationConfigArn(String replicationConfigArn)

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

      Parameters:
      replicationConfigArn - The Amazon Resource Name of the replication for which to start replication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startReplicationType

      StartReplicationRequest.Builder startReplicationType(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • premigrationAssessmentSettings

      StartReplicationRequest.Builder premigrationAssessmentSettings(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cdcStartTime

      StartReplicationRequest.Builder cdcStartTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cdcStartPosition

      StartReplicationRequest.Builder cdcStartPosition(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cdcStopPosition

      StartReplicationRequest.Builder cdcStopPosition(String cdcStopPosition)

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

      Parameters:
      cdcStopPosition - Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartReplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartReplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.