Package software.amazon.awssdk.services.cloudformation.model

Class DescribeStackDriftDetectionStatusResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
software.amazon.awssdk.services.cloudformation.model.DescribeStackDriftDetectionStatusResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeStackDriftDetectionStatusResponse extends CloudFormationResponse implements ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>

  • Method Details

    • stackId

      public final String stackId()

      The ID of the stack.

      Returns:
      The ID of the stack.

    • stackDriftDetectionId

      public final String stackDriftDetectionId()

      The ID of the drift detection results of this operation.

      CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

      Returns:
      The ID of the drift detection results of this operation.

      CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

    • stackDriftStatus

      public final StackDriftStatus stackDriftStatus()

      Status of the stack's actual configuration compared to its expected configuration.

      • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

      • IN_SYNC: The stack's actual configuration matches its expected template configuration.

      • UNKNOWN: This value is reserved for future use.

      If the service returns an enum value that is not available in the current SDK version, stackDriftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackDriftStatusAsString().

      Returns:
      Status of the stack's actual configuration compared to its expected configuration.

      • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

      • IN_SYNC: The stack's actual configuration matches its expected template configuration.

      • UNKNOWN: This value is reserved for future use.

      See Also:

    • stackDriftStatusAsString

      public final String stackDriftStatusAsString()

      Status of the stack's actual configuration compared to its expected configuration.

      • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

      • IN_SYNC: The stack's actual configuration matches its expected template configuration.

      • UNKNOWN: This value is reserved for future use.

      If the service returns an enum value that is not available in the current SDK version, stackDriftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackDriftStatusAsString().

      Returns:
      Status of the stack's actual configuration compared to its expected configuration.

      • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

      • IN_SYNC: The stack's actual configuration matches its expected template configuration.

      • UNKNOWN: This value is reserved for future use.

      See Also:

    • detectionStatus

      public final StackDriftDetectionStatus detectionStatus()

      The status of the stack drift detection operation.

      • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

        If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

      • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

      • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

      If the service returns an enum value that is not available in the current SDK version, detectionStatus will return StackDriftDetectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detectionStatusAsString().

      Returns:
      The status of the stack drift detection operation.

      • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

        If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

      • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

      • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

      See Also:

    • detectionStatusAsString

      public final String detectionStatusAsString()

      The status of the stack drift detection operation.

      • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

        If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

      • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

      • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

      If the service returns an enum value that is not available in the current SDK version, detectionStatus will return StackDriftDetectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detectionStatusAsString().

      Returns:
      The status of the stack drift detection operation.

      • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

        If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

      • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

      • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

      See Also:

    • detectionStatusReason

      public final String detectionStatusReason()

      The reason the stack drift detection operation has its current status.

      Returns:
      The reason the stack drift detection operation has its current status.

    • driftedStackResourceCount

      public final Integer driftedStackResourceCount()

      Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

      Returns:
      Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

    • timestamp

      public final Instant timestamp()

      Time at which the stack drift detection operation was initiated.

      Returns:
      Time at which the stack drift detection operation was initiated.

    • toBuilder

      public DescribeStackDriftDetectionStatusResponse.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<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeStackDriftDetectionStatusResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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