ReplicationTask.Builder (AWS Java SDK :: Services :: AWS Database Migration Service 2.21.12 API)

All Superinterfaces:

Buildable, CopyableBuilder<ReplicationTask.Builder,ReplicationTask>, SdkBuilder<ReplicationTask.Builder,ReplicationTask>, SdkPojo

Enclosing class:

ReplicationTask
```
public static interface ReplicationTask.Builder
extends SdkPojo, CopyableBuilder<ReplicationTask.Builder,ReplicationTask>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ReplicationTask.Builder`	`cdcStartPosition(String cdcStartPosition)` Indicates when you want a change data capture (CDC) operation to start.
`ReplicationTask.Builder`	`cdcStopPosition(String cdcStopPosition)` Indicates when you want a change data capture (CDC) operation to stop.
`ReplicationTask.Builder`	`lastFailureMessage(String lastFailureMessage)` The last error (failure) message generated for the replication task.
`ReplicationTask.Builder`	`migrationType(MigrationTypeValue migrationType)` The type of migration.
`ReplicationTask.Builder`	`migrationType(String migrationType)` The type of migration.
`ReplicationTask.Builder`	`recoveryCheckpoint(String recoveryCheckpoint)` Indicates the last checkpoint that occurred during a change data capture (CDC) operation.
`ReplicationTask.Builder`	`replicationInstanceArn(String replicationInstanceArn)` The ARN of the replication instance.
`ReplicationTask.Builder`	`replicationTaskArn(String replicationTaskArn)` The Amazon Resource Name (ARN) of the replication task.
`ReplicationTask.Builder`	`replicationTaskCreationDate(Instant replicationTaskCreationDate)` The date the replication task was created.
`ReplicationTask.Builder`	`replicationTaskIdentifier(String replicationTaskIdentifier)` The user-assigned replication task identifier or name.
`ReplicationTask.Builder`	`replicationTaskSettings(String replicationTaskSettings)` The settings for the replication task.
`ReplicationTask.Builder`	`replicationTaskStartDate(Instant replicationTaskStartDate)` The date the replication task is scheduled to start.
`default ReplicationTask.Builder`	`replicationTaskStats(Consumer<ReplicationTaskStats.Builder> replicationTaskStats)` The statistics for the task, including elapsed time, tables loaded, and table errors.
`ReplicationTask.Builder`	`replicationTaskStats(ReplicationTaskStats replicationTaskStats)` The statistics for the task, including elapsed time, tables loaded, and table errors.
`ReplicationTask.Builder`	`sourceEndpointArn(String sourceEndpointArn)` The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
`ReplicationTask.Builder`	`status(String status)` The status of the replication task.
`ReplicationTask.Builder`	`stopReason(String stopReason)` The reason the replication task was stopped.
`ReplicationTask.Builder`	`tableMappings(String tableMappings)` Table mappings specified in the task.
`ReplicationTask.Builder`	`targetEndpointArn(String targetEndpointArn)` The ARN that uniquely identifies the endpoint.
`ReplicationTask.Builder`	`targetReplicationInstanceArn(String targetReplicationInstanceArn)` The ARN of the replication instance to which this task is moved in response to running the `MoveReplicationTask` operation.
`ReplicationTask.Builder`	`taskData(String taskData)` Supplemental information that the task requires to migrate the data for certain source and target endpoints.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - replicationTaskIdentifier
```
ReplicationTask.Builder replicationTaskIdentifier(String replicationTaskIdentifier)
```
    The user-assigned replication task identifier or name.
    
    Constraints:
    - Must contain 1-255 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Parameters:
    replicationTaskIdentifier - The user-assigned replication task identifier or name.
    
    Constraints:
    
    Must contain 1-255 alphanumeric characters or hyphens.
    
    First character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sourceEndpointArn
```
ReplicationTask.Builder sourceEndpointArn(String sourceEndpointArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
    
    Parameters:
    
    sourceEndpointArn - The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targetEndpointArn
```
ReplicationTask.Builder targetEndpointArn(String targetEndpointArn)
```
    The ARN that uniquely identifies the endpoint.
    
    Parameters:
    
    targetEndpointArn - The ARN that uniquely identifies the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationInstanceArn
```
ReplicationTask.Builder replicationInstanceArn(String replicationInstanceArn)
```
    The ARN of the replication instance.
    
    Parameters:
    
    replicationInstanceArn - The ARN of the replication instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - migrationType
```
ReplicationTask.Builder migrationType(String migrationType)
```
    The type of migration.
    
    Parameters:
    
    migrationType - The type of migration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MigrationTypeValue, MigrationTypeValue
  - migrationType
```
ReplicationTask.Builder migrationType(MigrationTypeValue migrationType)
```
    The type of migration.
    
    Parameters:
    
    migrationType - The type of migration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MigrationTypeValue, MigrationTypeValue
  - tableMappings
```
ReplicationTask.Builder tableMappings(String tableMappings)
```
    Table mappings specified in the task.
    
    Parameters:
    
    tableMappings - Table mappings specified in the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskSettings
```
ReplicationTask.Builder replicationTaskSettings(String replicationTaskSettings)
```
    The settings for the replication task.
    
    Parameters:
    
    replicationTaskSettings - The settings for the replication task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
ReplicationTask.Builder status(String status)
```
    The status of the replication task. This response parameter can return one of the following values:
    - "moving" – The task is being moved in response to running the MoveReplicationTask operation.
    - "creating" – The task is being created in response to running the CreateReplicationTask operation.
    - "deleting" – The task is being deleted in response to running the DeleteReplicationTask operation.
    - "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation.
    - "failed-move" – The task failed to move in response to running the MoveReplicationTask operation.
    - "modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation.
    - "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask .
    - "running" – The task is performing a database migration in response to running the StartReplicationTask operation.
    - "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation.
    - "stopped" – The task has stopped in response to running the StopReplicationTask operation.
    - "stopping" – The task is preparing to stop in response to running the StopReplicationTask operation.
    - "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.
      
      StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
    Parameters:
    status - The status of the replication task. This response parameter can return one of the following values:
    
    "moving" – The task is being moved in response to running the MoveReplicationTask operation.
    
    "creating" – The task is being created in response to running the CreateReplicationTask operation.
    
    "deleting" – The task is being deleted in response to running the DeleteReplicationTask operation.
    
    "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation.
    
    "failed-move" – The task failed to move in response to running the MoveReplicationTask operation.
    
    "modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation.
    
    "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask .
    
    "running" – The task is performing a database migration in response to running the StartReplicationTask operation.
    
    "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation.
    
    "stopped" – The task has stopped in response to running the StopReplicationTask operation.
    
    "stopping" – The task is preparing to stop in response to running the StopReplicationTask operation.
    
    "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.
    
    StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastFailureMessage
```
ReplicationTask.Builder lastFailureMessage(String lastFailureMessage)
```
    The last error (failure) message generated for the replication task.
    
    Parameters:
    
    lastFailureMessage - The last error (failure) message generated for the replication task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stopReason
```
ReplicationTask.Builder stopReason(String stopReason)
```
    The reason the replication task was stopped. This response parameter can return one of the following values:
    - "Stop Reason NORMAL"
    - "Stop Reason RECOVERABLE_ERROR"
    - "Stop Reason FATAL_ERROR"
    - "Stop Reason FULL_LOAD_ONLY_FINISHED"
    - "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied
    - "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied
    - "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
    - "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
    - "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
    - "Stop Reason STOPPED_DUE_TO_LOW_DISK"
    - "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
    - "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
    - "Stop Reason RECONFIGURATION_RESTART"
    - "Stop Reason RECYCLE_TASK"
    Parameters:
    stopReason - The reason the replication task was stopped. This response parameter can return one of the following values:
    
    "Stop Reason NORMAL"
    
    "Stop Reason RECOVERABLE_ERROR"
    
    "Stop Reason FATAL_ERROR"
    
    "Stop Reason FULL_LOAD_ONLY_FINISHED"
    
    "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied
    
    "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied
    
    "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
    
    "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
    
    "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
    
    "Stop Reason STOPPED_DUE_TO_LOW_DISK"
    
    "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
    
    "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
    
    "Stop Reason RECONFIGURATION_RESTART"
    
    "Stop Reason RECYCLE_TASK"
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskCreationDate
```
ReplicationTask.Builder replicationTaskCreationDate(Instant replicationTaskCreationDate)
```
    The date the replication task was created.
    
    Parameters:
    
    replicationTaskCreationDate - The date the replication task was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskStartDate
```
ReplicationTask.Builder replicationTaskStartDate(Instant replicationTaskStartDate)
```
    The date the replication task is scheduled to start.
    
    Parameters:
    
    replicationTaskStartDate - The date the replication task is scheduled to start.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cdcStartPosition
```
ReplicationTask.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 the 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”
    
    Parameters:
    
    cdcStartPosition - Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the 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”
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cdcStopPosition
```
ReplicationTask.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.
    
    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“
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - recoveryCheckpoint
```
ReplicationTask.Builder recoveryCheckpoint(String recoveryCheckpoint)
```
    Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
    
    Parameters:
    
    recoveryCheckpoint - Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskArn
```
ReplicationTask.Builder replicationTaskArn(String replicationTaskArn)
```
    The Amazon Resource Name (ARN) of the replication task.
    
    Parameters:
    
    replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskStats
```
ReplicationTask.Builder replicationTaskStats(ReplicationTaskStats replicationTaskStats)
```
    The statistics for the task, including elapsed time, tables loaded, and table errors.
    
    Parameters:
    
    replicationTaskStats - The statistics for the task, including elapsed time, tables loaded, and table errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replicationTaskStats
```
default ReplicationTask.Builder replicationTaskStats(Consumer<ReplicationTaskStats.Builder> replicationTaskStats)
```
    The statistics for the task, including elapsed time, tables loaded, and table errors.
    This is a convenience method that creates an instance of the ReplicationTaskStats.Builder avoiding the need to create one manually via ReplicationTaskStats.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to replicationTaskStats(ReplicationTaskStats).
    
    Parameters:
    
    replicationTaskStats - a consumer that will call methods on ReplicationTaskStats.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    replicationTaskStats(ReplicationTaskStats)
  - taskData
```
ReplicationTask.Builder taskData(String taskData)
```
    Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
    
    Parameters:
    
    taskData - Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targetReplicationInstanceArn
```
ReplicationTask.Builder targetReplicationInstanceArn(String targetReplicationInstanceArn)
```
    The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
    
    Parameters:
    
    targetReplicationInstanceArn - The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface ReplicationTask.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

replicationTaskIdentifier

sourceEndpointArn

targetEndpointArn

replicationInstanceArn

migrationType

migrationType

tableMappings

replicationTaskSettings

status

lastFailureMessage

stopReason

replicationTaskCreationDate

replicationTaskStartDate

cdcStartPosition

cdcStopPosition

recoveryCheckpoint

replicationTaskArn

replicationTaskStats

replicationTaskStats

taskData

targetReplicationInstanceArn