Package software.amazon.awssdk.services.databasemigration.model

Interface ReplicationTaskAssessmentRun.Builder

All Superinterfaces:

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

Enclosing class:

ReplicationTaskAssessmentRun

@Mutable
@NotThreadSafe
public static interface ReplicationTaskAssessmentRun.Builder
extends SdkPojo, CopyableBuilder<ReplicationTaskAssessmentRun.Builder,ReplicationTaskAssessmentRun>

Method Summary

Modifier and Type	Method	Description
default ReplicationTaskAssessmentRun.Builder	assessmentProgress(Consumer<ReplicationTaskAssessmentRunProgress.Builder> assessmentProgress)	Indication of the completion progress for the individual assessments specified to run.
ReplicationTaskAssessmentRun.Builder	assessmentProgress(ReplicationTaskAssessmentRunProgress assessmentProgress)	Indication of the completion progress for the individual assessments specified to run.
ReplicationTaskAssessmentRun.Builder	assessmentRunName(String assessmentRunName)	Unique name of the assessment run.
ReplicationTaskAssessmentRun.Builder	isLatestTaskAssessmentRun(Boolean isLatestTaskAssessmentRun)	Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask.
ReplicationTaskAssessmentRun.Builder	lastFailureMessage(String lastFailureMessage)	Last message generated by an individual assessment failure.
ReplicationTaskAssessmentRun.Builder	replicationTaskArn(String replicationTaskArn)	ARN of the migration task associated with this premigration assessment run.
ReplicationTaskAssessmentRun.Builder	replicationTaskAssessmentRunArn(String replicationTaskAssessmentRunArn)	Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskAssessmentRun.Builder	replicationTaskAssessmentRunCreationDate(Instant replicationTaskAssessmentRunCreationDate)	Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
ReplicationTaskAssessmentRun.Builder	resultEncryptionMode(String resultEncryptionMode)	Encryption mode used to encrypt the assessment run results.
ReplicationTaskAssessmentRun.Builder	resultKmsKeyArn(String resultKmsKeyArn)	ARN of the KMS encryption key used to encrypt the assessment run results.
ReplicationTaskAssessmentRun.Builder	resultLocationBucket(String resultLocationBucket)	Amazon S3 bucket where DMS stores the results of this assessment run.
ReplicationTaskAssessmentRun.Builder	resultLocationFolder(String resultLocationFolder)	Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
default ReplicationTaskAssessmentRun.Builder	resultStatistic(Consumer<ReplicationTaskAssessmentRunResultStatistic.Builder> resultStatistic)	Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
ReplicationTaskAssessmentRun.Builder	resultStatistic(ReplicationTaskAssessmentRunResultStatistic resultStatistic)	Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.
ReplicationTaskAssessmentRun.Builder	serviceAccessRoleArn(String serviceAccessRoleArn)	ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
ReplicationTaskAssessmentRun.Builder	status(String status)	Assessment run status.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

replicationTaskAssessmentRunArn

ReplicationTaskAssessmentRun.Builder replicationTaskAssessmentRunArn(String replicationTaskAssessmentRunArn)

Amazon Resource Name (ARN) of this assessment run.

Parameters:

replicationTaskAssessmentRunArn - Amazon Resource Name (ARN) of this assessment run.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationTaskArn

ReplicationTaskAssessmentRun.Builder replicationTaskArn(String replicationTaskArn)

ARN of the migration task associated with this premigration assessment run.

Parameters:

replicationTaskArn - ARN of the migration task associated with this premigration assessment run.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

ReplicationTaskAssessmentRun.Builder status(String status)

Assessment run status.

This status can have one of the following values:

• "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.

• "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.

• "failed" – At least one individual assessment completed with a failed status.

• "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).

• "error-executing" – An internal error occurred while individual assessments ran (during running status).

• "invalid state" – The assessment run is in an unknown state.

• "passed" – All individual assessments have completed, and none has a failed status.

• "provisioning" – Resources required to run individual assessments are being provisioned.

• "running" – Individual assessments are being run.

• "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.

• "warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).

Parameters:

status - Assessment run status.

This status can have one of the following values:

• "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.

• "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.

• "failed" – At least one individual assessment completed with a failed status.

• "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).

• "error-executing" – An internal error occurred while individual assessments ran (during running status).

• "invalid state" – The assessment run is in an unknown state.

• "passed" – All individual assessments have completed, and none has a failed status.

• "provisioning" – Resources required to run individual assessments are being provisioned.

• "running" – Individual assessments are being run.

• "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.

• "warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationTaskAssessmentRunCreationDate

ReplicationTaskAssessmentRun.Builder replicationTaskAssessmentRunCreationDate(Instant replicationTaskAssessmentRunCreationDate)

Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

Parameters:

replicationTaskAssessmentRunCreationDate - Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

assessmentProgress

ReplicationTaskAssessmentRun.Builder assessmentProgress(ReplicationTaskAssessmentRunProgress assessmentProgress)

Indication of the completion progress for the individual assessments specified to run.

Parameters:

assessmentProgress - Indication of the completion progress for the individual assessments specified to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

assessmentProgress

default ReplicationTaskAssessmentRun.Builder assessmentProgress(Consumer<ReplicationTaskAssessmentRunProgress.Builder> assessmentProgress)

Indication of the completion progress for the individual assessments specified to run.

This is a convenience method that creates an instance of the ReplicationTaskAssessmentRunProgress.Builder avoiding the need to create one manually via ReplicationTaskAssessmentRunProgress.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assessmentProgress(ReplicationTaskAssessmentRunProgress).

Parameters:

assessmentProgress - a consumer that will call methods on ReplicationTaskAssessmentRunProgress.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

assessmentProgress(ReplicationTaskAssessmentRunProgress)

lastFailureMessage

ReplicationTaskAssessmentRun.Builder lastFailureMessage(String lastFailureMessage)

Last message generated by an individual assessment failure.

Parameters:

lastFailureMessage - Last message generated by an individual assessment failure.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceAccessRoleArn

ReplicationTaskAssessmentRun.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

Parameters:

serviceAccessRoleArn - ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultLocationBucket

ReplicationTaskAssessmentRun.Builder resultLocationBucket(String resultLocationBucket)

Amazon S3 bucket where DMS stores the results of this assessment run.

Parameters:

resultLocationBucket - Amazon S3 bucket where DMS stores the results of this assessment run.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultLocationFolder

ReplicationTaskAssessmentRun.Builder resultLocationFolder(String resultLocationFolder)

Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

Parameters:

resultLocationFolder - Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultEncryptionMode

ReplicationTaskAssessmentRun.Builder resultEncryptionMode(String resultEncryptionMode)

Encryption mode used to encrypt the assessment run results.

Parameters:

resultEncryptionMode - Encryption mode used to encrypt the assessment run results.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultKmsKeyArn

ReplicationTaskAssessmentRun.Builder resultKmsKeyArn(String resultKmsKeyArn)

ARN of the KMS encryption key used to encrypt the assessment run results.

Parameters:

resultKmsKeyArn - ARN of the KMS encryption key used to encrypt the assessment run results.

Returns:

Returns a reference to this object so that method calls can be chained together.

assessmentRunName

ReplicationTaskAssessmentRun.Builder assessmentRunName(String assessmentRunName)

Unique name of the assessment run.

Parameters:

assessmentRunName - Unique name of the assessment run.

Returns:

Returns a reference to this object so that method calls can be chained together.

isLatestTaskAssessmentRun

ReplicationTaskAssessmentRun.Builder isLatestTaskAssessmentRun(Boolean isLatestTaskAssessmentRun)

Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

Parameters:

isLatestTaskAssessmentRun - Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultStatistic

ReplicationTaskAssessmentRun.Builder resultStatistic(ReplicationTaskAssessmentRunResultStatistic resultStatistic)

Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

Parameters:

resultStatistic - Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

Returns:

Returns a reference to this object so that method calls can be chained together.

resultStatistic

default ReplicationTaskAssessmentRun.Builder resultStatistic(Consumer<ReplicationTaskAssessmentRunResultStatistic.Builder> resultStatistic)

Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

This is a convenience method that creates an instance of the ReplicationTaskAssessmentRunResultStatistic.Builder avoiding the need to create one manually via ReplicationTaskAssessmentRunResultStatistic.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resultStatistic(ReplicationTaskAssessmentRunResultStatistic).

Parameters:

resultStatistic - a consumer that will call methods on ReplicationTaskAssessmentRunResultStatistic.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

resultStatistic(ReplicationTaskAssessmentRunResultStatistic)