/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.databasemigrationservice.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartReplicationTaskAssessmentRunRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to * start. *
*/ private String replicationTaskArn; /** *
* ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole
* action.
*
* Amazon S3 bucket where you want DMS to store the results of this assessment run. *
*/ private String resultLocationBucket; /** ** Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. *
*/ private String resultLocationFolder; /** ** 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.
*
* ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode
to
* "SSE_KMS
".
*
* Unique name to identify the assessment run. *
*/ private String assessmentRunName; /** *
* 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
* Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to * start. *
* * @param replicationTaskArn * Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you * want to start. */ public void setReplicationTaskArn(String replicationTaskArn) { this.replicationTaskArn = replicationTaskArn; } /** ** Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to * start. *
* * @return Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you * want to start. */ public String getReplicationTaskArn() { return this.replicationTaskArn; } /** ** Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to * start. *
* * @param replicationTaskArn * Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you * want to start. * @return Returns a reference to this object so that method calls can be chained together. */ public StartReplicationTaskAssessmentRunRequest withReplicationTaskArn(String replicationTaskArn) { setReplicationTaskArn(replicationTaskArn); return this; } /** *
* ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole
* action.
*
iam:PassRole
action.
*/
public void setServiceAccessRoleArn(String serviceAccessRoleArn) {
this.serviceAccessRoleArn = serviceAccessRoleArn;
}
/**
*
* ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole
* action.
*
iam:PassRole
action.
*/
public String getServiceAccessRoleArn() {
return this.serviceAccessRoleArn;
}
/**
*
* ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole
* action.
*
iam:PassRole
action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartReplicationTaskAssessmentRunRequest withServiceAccessRoleArn(String serviceAccessRoleArn) {
setServiceAccessRoleArn(serviceAccessRoleArn);
return this;
}
/**
* * Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @param resultLocationBucket * Amazon S3 bucket where you want DMS to store the results of this assessment run. */ public void setResultLocationBucket(String resultLocationBucket) { this.resultLocationBucket = resultLocationBucket; } /** ** Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @return Amazon S3 bucket where you want DMS to store the results of this assessment run. */ public String getResultLocationBucket() { return this.resultLocationBucket; } /** ** Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @param resultLocationBucket * Amazon S3 bucket where you want DMS to store the results of this assessment run. * @return Returns a reference to this object so that method calls can be chained together. */ public StartReplicationTaskAssessmentRunRequest withResultLocationBucket(String resultLocationBucket) { setResultLocationBucket(resultLocationBucket); return this; } /** ** Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @param resultLocationFolder * Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. */ public void setResultLocationFolder(String resultLocationFolder) { this.resultLocationFolder = resultLocationFolder; } /** ** Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @return Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. */ public String getResultLocationFolder() { return this.resultLocationFolder; } /** ** Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. *
* * @param resultLocationFolder * Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run. * @return Returns a reference to this object so that method calls can be chained together. */ public StartReplicationTaskAssessmentRunRequest withResultLocationFolder(String resultLocationFolder) { setResultLocationFolder(resultLocationFolder); return this; } /** ** 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.
*
* "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.
*
* 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.
*
* "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.
*
* 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.
*
* "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.
*
* ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode
to
* "SSE_KMS
".
*
ResultEncryptionMode
to
* "SSE_KMS
".
*/
public void setResultKmsKeyArn(String resultKmsKeyArn) {
this.resultKmsKeyArn = resultKmsKeyArn;
}
/**
*
* ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode
to
* "SSE_KMS
".
*
ResultEncryptionMode
to
* "SSE_KMS
".
*/
public String getResultKmsKeyArn() {
return this.resultKmsKeyArn;
}
/**
*
* ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode
to
* "SSE_KMS
".
*
ResultEncryptionMode
to
* "SSE_KMS
".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartReplicationTaskAssessmentRunRequest withResultKmsKeyArn(String resultKmsKeyArn) {
setResultKmsKeyArn(resultKmsKeyArn);
return this;
}
/**
* * Unique name to identify the assessment run. *
* * @param assessmentRunName * Unique name to identify the assessment run. */ public void setAssessmentRunName(String assessmentRunName) { this.assessmentRunName = assessmentRunName; } /** ** Unique name to identify the assessment run. *
* * @return Unique name to identify the assessment run. */ public String getAssessmentRunName() { return this.assessmentRunName; } /** ** Unique name to identify the assessment run. *
* * @param assessmentRunName * Unique name to identify the assessment run. * @return Returns a reference to this object so that method calls can be chained together. */ public StartReplicationTaskAssessmentRunRequest withAssessmentRunName(String assessmentRunName) { setAssessmentRunName(assessmentRunName); return this; } /** *
* 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for IncludeOnly
if you also set a value for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for IncludeOnly
if you also set a value for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setIncludeOnly(java.util.Collection)} or {@link #withIncludeOnly(java.util.Collection)} if you want to * override the existing values. *
* * @param 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for IncludeOnly
if you also set a value for Exclude
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for Exclude
if you also set a value for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for Exclude
if you also set a value for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setExclude(java.util.Collection)} or {@link #withExclude(java.util.Collection)} if you want to override * the existing values. *
* * @param 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
* 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 for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*
ReplicationTaskArn
.
* You can't set a value for Exclude
if you also set a value for IncludeOnly
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 own
* ReplicationTaskArn
request parameter.
*