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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass StartReplicationTaskAssessmentRunMessage data as a hash:

{
  replication_task_arn: "String", # required
  service_access_role_arn: "String", # required
  result_location_bucket: "String", # required
  result_location_folder: "String",
  result_encryption_mode: "String",
  result_kms_key_arn: "String",
  assessment_run_name: "String", # required
  include_only: ["String"],
  exclude: ["String"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_run_nameString

Unique name to identify the assessment run.

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#excludeArray<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 AWS 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 AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

Returns:

  • (Array<String>)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#include_onlyArray<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 AWS 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 AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

Returns:

  • (Array<String>)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#replication_task_arnString

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

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#result_encryption_modeString

Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, AWS 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" – AWS Key Management Service (AWS 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)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#result_kms_key_arnString

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

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_bucketString

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

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_folderString

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

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arnString

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

Returns:

  • (String)


8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 8073

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)
  SENSITIVE = []
  include Aws::Structure
end