Interface StartReplicationTaskAssessmentRunRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartReplicationTaskAssessmentRunRequest.Builder,
,StartReplicationTaskAssessmentRunRequest> DatabaseMigrationRequest.Builder
,SdkBuilder<StartReplicationTaskAssessmentRunRequest.Builder,
,StartReplicationTaskAssessmentRunRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartReplicationTaskAssessmentRunRequest
-
Method Summary
Modifier and TypeMethodDescriptionassessmentRunName
(String assessmentRunName) Unique name to identify the assessment run.Space-separated list of names for specific individual assessments that you want to exclude.exclude
(Collection<String> exclude) Space-separated list of names for specific individual assessments that you want to exclude.includeOnly
(String... includeOnly) Space-separated list of names for specific individual assessments that you want to include.includeOnly
(Collection<String> includeOnly) Space-separated list of names for specific individual assessments that you want to include.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.replicationTaskArn
(String replicationTaskArn) Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.resultEncryptionMode
(String resultEncryptionMode) Encryption mode that you can specify to encrypt the results of this assessment run.resultKmsKeyArn
(String resultKmsKeyArn) ARN of a custom KMS encryption key that you specify when you setResultEncryptionMode
to"SSE_KMS
".resultLocationBucket
(String resultLocationBucket) Amazon S3 bucket where you want DMS to store the results of this assessment run.resultLocationFolder
(String resultLocationFolder) Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.serviceAccessRoleArn
(String serviceAccessRoleArn) ARN of the service role needed to start the assessment run.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
replicationTaskArn
Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
- Parameters:
replicationTaskArn
- Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceAccessRoleArn
ARN of the service role needed to start the assessment run. The role must allow the
iam:PassRole
action.- Parameters:
serviceAccessRoleArn
- ARN of the service role needed to start the assessment run. The role must allow theiam:PassRole
action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultLocationBucket
Amazon S3 bucket where you want DMS to store the results of this assessment run.
- Parameters:
resultLocationBucket
- Amazon S3 bucket where you want DMS to store the results of this assessment run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultLocationFolder
Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
- Parameters:
resultLocationFolder
- Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resultEncryptionMode
Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:
-
"SSE_S3"
– The server-side encryption provided as a default by Amazon S3. -
"SSE_KMS"
– Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
- Parameters:
resultEncryptionMode
- Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:-
"SSE_S3"
– The server-side encryption provided as a default by Amazon S3. -
"SSE_KMS"
– Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
resultKmsKeyArn
ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionMode
to"SSE_KMS
".- Parameters:
resultKmsKeyArn
- ARN of a custom KMS encryption key that you specify when you setResultEncryptionMode
to"SSE_KMS
".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assessmentRunName
Unique name to identify the assessment run.
- Parameters:
assessmentRunName
- Unique name to identify the assessment run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeOnly
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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can't set a value for
IncludeOnly
if you also set a value forExclude
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Parameters:
includeOnly
- 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 DMS supports for the associated migration task. This task is specified byReplicationTaskArn
.You can't set a value for
IncludeOnly
if you also set a value forExclude
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeOnly
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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can't set a value for
IncludeOnly
if you also set a value forExclude
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Parameters:
includeOnly
- 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 DMS supports for the associated migration task. This task is specified byReplicationTaskArn
.You can't set a value for
IncludeOnly
if you also set a value forExclude
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclude
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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can't set a value for
Exclude
if you also set a value forIncludeOnly
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Parameters:
exclude
- 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 DMS supports for the associated migration task. This task is specified byReplicationTaskArn
.You can't set a value for
Exclude
if you also set a value forIncludeOnly
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclude
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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can't set a value for
Exclude
if you also set a value forIncludeOnly
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Parameters:
exclude
- 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 DMS supports for the associated migration task. This task is specified byReplicationTaskArn
.You can't set a value for
Exclude
if you also set a value forIncludeOnly
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartReplicationTaskAssessmentRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartReplicationTaskAssessmentRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-