Class: Aws::DatabaseMigrationService::Types::StartReplicationTaskAssessmentRunMessage

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::StartReplicationTaskAssessmentRunMessage

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assessment_run_name ⇒ String

  Unique name to identify the assessment run.

• #exclude ⇒ Array<String>

  Space-separated list of names for specific individual assessments that you want to exclude.

• #include_only ⇒ Array<String>

  Space-separated list of names for specific individual assessments that you want to include.

• #replication_task_arn ⇒ String

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

• #result_encryption_mode ⇒ String

  Encryption mode that you can specify to encrypt the results of this assessment run.

• #result_kms_key_arn ⇒ String

  ARN of a custom KMS encryption key that you specify when you set ‘ResultEncryptionMode` to `“SSE_KMS`”.

• #result_location_bucket ⇒ String

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

• #result_location_folder ⇒ String

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

• #service_access_role_arn ⇒ String

  ARN of the service role needed to start the assessment run.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#assessment_run_name ⇒ String

Unique name to identify the assessment run.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#exclude ⇒ Array<String>

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

<note markdown=“1”> 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>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#include_only ⇒ Array<String>

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

<note markdown=“1”> 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>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#result_encryption_mode ⇒ String

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:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#result_kms_key_arn ⇒ String

ARN of a custom KMS encryption key that you specify when you set ‘ResultEncryptionMode` to `“SSE_KMS`”.

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_bucket ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_folder ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 13428

class StartReplicationTaskAssessmentRunMessage < Struct.new(
  :replication_task_arn,
  :service_access_role_arn,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :assessment_run_name,
  :include_only,
  :exclude,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end