Class PremigrationAssessmentStatus

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.PremigrationAssessmentStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>
@Generated("software.amazon.awssdk:codegen") public final class PremigrationAssessmentStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>

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

See Also:

  • Method Details

    • premigrationAssessmentRunArn

      public final String premigrationAssessmentRunArn()

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

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

    • failOnAssessmentFailure

      public final Boolean failOnAssessmentFailure()

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

    • status

      public final String status()

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

    • premigrationAssessmentRunCreationDate

      public final Instant premigrationAssessmentRunCreationDate()

      The date which the assessment run was created.

      Returns:
      The date which the assessment run was created.

    • assessmentProgress

      public final ReplicationTaskAssessmentRunProgress assessmentProgress()
      Returns the value of the AssessmentProgress property for this object.
      Returns:
      The value of the AssessmentProgress property for this object.

    • lastFailureMessage

      public final String lastFailureMessage()

      The last message generated by an individual assessment failure.

      Returns:
      The last message generated by an individual assessment failure.

    • resultLocationBucket

      public final String resultLocationBucket()

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

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

    • resultLocationFolder

      public final String resultLocationFolder()

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

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

    • resultEncryptionMode

      public final String resultEncryptionMode()

      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.

      Returns:
      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.

    • resultKmsKeyArn

      public final String resultKmsKeyArn()

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

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

    • resultStatistic

      public final ReplicationTaskAssessmentRunResultStatistic resultStatistic()
      Returns the value of the ResultStatistic property for this object.
      Returns:
      The value of the ResultStatistic property for this object.

    • toBuilder

      public PremigrationAssessmentStatus.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>
      Returns:
      a builder for type T

    • builder

      public static PremigrationAssessmentStatus.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PremigrationAssessmentStatus.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.