Class: Aws::DatabaseMigrationService::Types::PremigrationAssessmentStatus

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::PremigrationAssessmentStatus

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

The results returned in ‘describe-replications` to display the results of the premigration assessment from the replication configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assessment_progress ⇒ Types::ReplicationTaskAssessmentRunProgress

  The progress values reported by the ‘AssessmentProgress` response element.

• #fail_on_assessment_failure ⇒ Boolean

  A configurable setting you can set to ‘true` (the defualt setting) or `false`.

• #last_failure_message ⇒ String

  The last message generated by an individual assessment failure.

• #premigration_assessment_run_arn ⇒ String

  The Amazon Resource Name (ARN) of this assessment run.

• #premigration_assessment_run_creation_date ⇒ Time

  The date which the assessment run was created.

• #result_encryption_mode ⇒ String

  The supported values are ‘SSE_KMS` and `SSE_S3`.

• #result_kms_key_arn ⇒ String

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

• #result_location_bucket ⇒ String

  The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.

• #result_location_folder ⇒ String

  The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.

• #result_statistic ⇒ Types::ReplicationTaskAssessmentRunResultStatistic

  The object containing the result statistics for a completed assessment run.

• #status ⇒ String

  This describes the assessment run status.

Instance Attribute Details

#assessment_progress ⇒ Types::ReplicationTaskAssessmentRunProgress

The progress values reported by the ‘AssessmentProgress` response element.

Returns:

• (Types::ReplicationTaskAssessmentRunProgress)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#fail_on_assessment_failure ⇒ Boolean

A configurable setting you can set to ‘true` (the defualt setting) or `false`. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.

Returns:

• (Boolean)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#last_failure_message ⇒ String

The last message generated by an individual assessment failure.

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#premigration_assessment_run_arn ⇒ String

The Amazon Resource Name (ARN) of this assessment run.

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#premigration_assessment_run_creation_date ⇒ Time

The date which the assessment run was created.

Returns:

• (Time)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#result_encryption_mode ⇒ String

The supported values are ‘SSE_KMS` and `SSE_S3`. If these values are not provided, then the files are not encrypted at rest. For more information, see [Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects].

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.KMSKeys

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#result_kms_key_arn ⇒ String

The 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 10068

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_bucket ⇒ String

The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#result_location_folder ⇒ String

The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#result_statistic ⇒ Types::ReplicationTaskAssessmentRunResultStatistic

The object containing the result statistics for a completed assessment run.

Returns:

• (Types::ReplicationTaskAssessmentRunResultStatistic)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

This describes the assessment run status. The status can be one of the following values:

• ‘cancelling`: The assessment run was canceled.

• ‘deleting`: The assessment run was deleted.

• ‘failed`: At least one individual assessment completed with a failed status.

• ‘error-provisioning`: An internal error occurred while resources were provisioned (during the `provisioning` status).

• ‘error-executing` An internal error occurred while individual assessments ran (during the `running` status).

• ‘invalid state`: The assessment run is in an unknown state.

• ‘passed`: All individual assessments have completed and none have a failed status.

• ‘provisioning`: The resources required to run individual assessments are being provisioned.

• ‘running`: Individual assessments are being run.

• ‘starting`: The assessment run is starting, but resources are not yet being provisioned for individual assessments.

• ‘warning`: At least one individual assessment completed with a warning status.

Returns:

• (String)

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

class PremigrationAssessmentStatus < Struct.new(
  :premigration_assessment_run_arn,
  :fail_on_assessment_failure,
  :status,
  :premigration_assessment_run_creation_date,
  :assessment_progress,
  :last_failure_message,
  :result_location_bucket,
  :result_location_folder,
  :result_encryption_mode,
  :result_kms_key_arn,
  :result_statistic)
  SENSITIVE = []
  include Aws::Structure
end