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

Interface StartReplicationTaskAssessmentRunRequest.Builder

    • Method Detail

      • replicationTaskArn

        StartReplicationTaskAssessmentRunRequest.Builder replicationTaskArn​(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.

      • serviceAccessRoleArn

        StartReplicationTaskAssessmentRunRequest.Builder serviceAccessRoleArn​(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.

      • resultLocationBucket

        StartReplicationTaskAssessmentRunRequest.Builder resultLocationBucket​(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.

      • resultLocationFolder

        StartReplicationTaskAssessmentRunRequest.Builder resultLocationFolder​(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.

      • resultEncryptionMode

        StartReplicationTaskAssessmentRunRequest.Builder resultEncryptionMode​(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.

      • resultKmsKeyArn

        StartReplicationTaskAssessmentRunRequest.Builder resultKmsKeyArn​(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.

      • assessmentRunName

        StartReplicationTaskAssessmentRunRequest.Builder assessmentRunName​(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.

      • includeOnly

        StartReplicationTaskAssessmentRunRequest.Builder includeOnly​(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.

      • includeOnly

        StartReplicationTaskAssessmentRunRequest.Builder includeOnly​(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.

      • exclude

        StartReplicationTaskAssessmentRunRequest.Builder exclude​(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.

      • exclude

        StartReplicationTaskAssessmentRunRequest.Builder exclude​(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.