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

Class StartReplicationTaskAssessmentRunRequest

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<Tag> tags()

        One or more tags to be assigned to the premigration assessment run that you want to start.

        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 hasTags() method.

        Returns:
        One or more tags to be assigned to the premigration assessment run that you want to start.

      • 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