software.amazon.awssdk.services.databasemigration.model

Class StartReplicationTaskAssessmentRunRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest

software.amazon.awssdk.services.databasemigration.model.StartReplicationTaskAssessmentRunRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartReplicationTaskAssessmentRunRequest.Builder,StartReplicationTaskAssessmentRunRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartReplicationTaskAssessmentRunRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<StartReplicationTaskAssessmentRunRequest.Builder,StartReplicationTaskAssessmentRunRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartReplicationTaskAssessmentRunRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assessmentRunName() Unique name to identify the assessment run.
static StartReplicationTaskAssessmentRunRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exclude() Space-separated list of names for specific individual assessments that you want to exclude.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExclude() For responses, this returns true if the service returned a value for the Exclude property.
int	hashCode()
boolean	hasIncludeOnly() For responses, this returns true if the service returned a value for the IncludeOnly property.
List<String>	includeOnly() Space-separated list of names for specific individual assessments that you want to include.
String	replicationTaskArn() Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
String	resultEncryptionMode() Encryption mode that you can specify to encrypt the results of this assessment run.
String	resultKmsKeyArn() ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
String	resultLocationBucket() Amazon S3 bucket where you want DMS to store the results of this assessment run.
String	resultLocationFolder() Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
List<SdkField<?>>	sdkFields()
static Class<? extends StartReplicationTaskAssessmentRunRequest.Builder>	serializableBuilderClass()
String	serviceAccessRoleArn() ARN of the service role needed to start the assessment run.
StartReplicationTaskAssessmentRunRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

replicationTaskArn

public final String replicationTaskArn()

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.

serviceAccessRoleArn

public final String serviceAccessRoleArn()

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.

resultLocationBucket

public final String resultLocationBucket()

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.

resultLocationFolder

public final String resultLocationFolder()

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.

resultEncryptionMode

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

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.

resultKmsKeyArn

public final String resultKmsKeyArn()

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

assessmentRunName

public final String assessmentRunName()

Unique name to identify the assessment run.

Returns:

Unique name to identify the assessment run.

hasIncludeOnly

public final boolean hasIncludeOnly()

For responses, this returns true if the service returned a value for the IncludeOnly property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

includeOnly

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeOnly() method.

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.

hasExclude

public final boolean hasExclude()

For responses, this returns true if the service returned a value for the Exclude property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

exclude

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExclude() method.

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.

toBuilder

public StartReplicationTaskAssessmentRunRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartReplicationTaskAssessmentRunRequest.Builder,StartReplicationTaskAssessmentRunRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

builder

public static StartReplicationTaskAssessmentRunRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartReplicationTaskAssessmentRunRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo