com.amazonaws.services.databasemigrationservice.model

Class StartReplicationTaskAssessmentRunRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskAssessmentRunRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartReplicationTaskAssessmentRunRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartReplicationTaskAssessmentRunRequest()

Method Summary

Modifier and Type	Method and Description
StartReplicationTaskAssessmentRunRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAssessmentRunName() Unique name to identify the assessment run.
List<String>	getExclude() Space-separated list of names for specific individual assessments that you want to exclude.
List<String>	getIncludeOnly() Space-separated list of names for specific individual assessments that you want to include.
String	getReplicationTaskArn() Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
String	getResultEncryptionMode() Encryption mode that you can specify to encrypt the results of this assessment run.
String	getResultKmsKeyArn() ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
String	getResultLocationBucket() Amazon S3 bucket where you want DMS to store the results of this assessment run.
String	getResultLocationFolder() Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
String	getServiceAccessRoleArn() ARN of the service role needed to start the assessment run.
int	hashCode()
void	setAssessmentRunName(String assessmentRunName) Unique name to identify the assessment run.
void	setExclude(Collection<String> exclude) Space-separated list of names for specific individual assessments that you want to exclude.
void	setIncludeOnly(Collection<String> includeOnly) Space-separated list of names for specific individual assessments that you want to include.
void	setReplicationTaskArn(String replicationTaskArn) Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
void	setResultEncryptionMode(String resultEncryptionMode) Encryption mode that you can specify to encrypt the results of this assessment run.
void	setResultKmsKeyArn(String resultKmsKeyArn) ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
void	setResultLocationBucket(String resultLocationBucket) Amazon S3 bucket where you want DMS to store the results of this assessment run.
void	setResultLocationFolder(String resultLocationFolder) Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
void	setServiceAccessRoleArn(String serviceAccessRoleArn) ARN of the service role needed to start the assessment run.
String	toString() Returns a string representation of this object.
StartReplicationTaskAssessmentRunRequest	withAssessmentRunName(String assessmentRunName) Unique name to identify the assessment run.
StartReplicationTaskAssessmentRunRequest	withExclude(Collection<String> exclude) Space-separated list of names for specific individual assessments that you want to exclude.
StartReplicationTaskAssessmentRunRequest	withExclude(String... exclude) Space-separated list of names for specific individual assessments that you want to exclude.
StartReplicationTaskAssessmentRunRequest	withIncludeOnly(Collection<String> includeOnly) Space-separated list of names for specific individual assessments that you want to include.
StartReplicationTaskAssessmentRunRequest	withIncludeOnly(String... includeOnly) Space-separated list of names for specific individual assessments that you want to include.
StartReplicationTaskAssessmentRunRequest	withReplicationTaskArn(String replicationTaskArn) Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
StartReplicationTaskAssessmentRunRequest	withResultEncryptionMode(String resultEncryptionMode) Encryption mode that you can specify to encrypt the results of this assessment run.
StartReplicationTaskAssessmentRunRequest	withResultKmsKeyArn(String resultKmsKeyArn) ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
StartReplicationTaskAssessmentRunRequest	withResultLocationBucket(String resultLocationBucket) Amazon S3 bucket where you want DMS to store the results of this assessment run.
StartReplicationTaskAssessmentRunRequest	withResultLocationFolder(String resultLocationFolder) Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
StartReplicationTaskAssessmentRunRequest	withServiceAccessRoleArn(String serviceAccessRoleArn) ARN of the service role needed to start the assessment run.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartReplicationTaskAssessmentRunRequest

public StartReplicationTaskAssessmentRunRequest()

Method Detail

setReplicationTaskArn

public void setReplicationTaskArn(String 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.

getReplicationTaskArn

public String getReplicationTaskArn()

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

Returns:

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

withReplicationTaskArn

public StartReplicationTaskAssessmentRunRequest withReplicationTaskArn(String 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.

setServiceAccessRoleArn

public void setServiceAccessRoleArn(String 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 the iam:PassRole action.

getServiceAccessRoleArn

public String getServiceAccessRoleArn()

ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

Returns:

ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

withServiceAccessRoleArn

public StartReplicationTaskAssessmentRunRequest withServiceAccessRoleArn(String 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 the iam:PassRole action.

Returns:

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

setResultLocationBucket

public void setResultLocationBucket(String 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.

getResultLocationBucket

public String getResultLocationBucket()

Amazon S3 bucket where you want DMS to store the results of this assessment run.

Returns:

Amazon S3 bucket where you want DMS to store the results of this assessment run.

withResultLocationBucket

public StartReplicationTaskAssessmentRunRequest withResultLocationBucket(String 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.

setResultLocationFolder

public void setResultLocationFolder(String 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.

getResultLocationFolder

public String getResultLocationFolder()

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

Returns:

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

withResultLocationFolder

public StartReplicationTaskAssessmentRunRequest withResultLocationFolder(String 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.

setResultEncryptionMode

public void setResultEncryptionMode(String 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.

getResultEncryptionMode

public String getResultEncryptionMode()

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:

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.

withResultEncryptionMode

public StartReplicationTaskAssessmentRunRequest withResultEncryptionMode(String 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.

setResultKmsKeyArn

public void setResultKmsKeyArn(String 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 set ResultEncryptionMode to "SSE_KMS".

getResultKmsKeyArn

public String getResultKmsKeyArn()

ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

Returns:

ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

withResultKmsKeyArn

public StartReplicationTaskAssessmentRunRequest withResultKmsKeyArn(String 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 set ResultEncryptionMode to "SSE_KMS".

Returns:

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

setAssessmentRunName

public void setAssessmentRunName(String assessmentRunName)

Unique name to identify the assessment run.

Parameters:

assessmentRunName - Unique name to identify the assessment run.

getAssessmentRunName

public String getAssessmentRunName()

Unique name to identify the assessment run.

Returns:

Unique name to identify the assessment run.

withAssessmentRunName

public StartReplicationTaskAssessmentRunRequest withAssessmentRunName(String 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.

getIncludeOnly

public List<String> getIncludeOnly()

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.

Returns:

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.

setIncludeOnly

public void setIncludeOnly(Collection<String> 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 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.

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 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.

withIncludeOnly

public StartReplicationTaskAssessmentRunRequest withIncludeOnly(String... 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 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 setIncludeOnly(java.util.Collection) or withIncludeOnly(java.util.Collection) if you want to override the existing values.

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 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.

Returns:

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

withIncludeOnly

public StartReplicationTaskAssessmentRunRequest withIncludeOnly(Collection<String> 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 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.

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 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.

Returns:

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

getExclude

public List<String> getExclude()

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.

Returns:

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.

setExclude

public void setExclude(Collection<String> 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 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.

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 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.

withExclude

public StartReplicationTaskAssessmentRunRequest withExclude(String... 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 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 setExclude(java.util.Collection) or withExclude(java.util.Collection) if you want to override the existing values.

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 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.

Returns:

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

withExclude

public StartReplicationTaskAssessmentRunRequest withExclude(Collection<String> 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 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.

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 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.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartReplicationTaskAssessmentRunRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()