Class StackSetDriftDetectionDetails

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

Detailed information about the drift status of the StackSet.

For StackSets, contains information about the last completed drift operation performed on the StackSet. Information about drift operations in-progress isn't included.

For StackSet operations, includes information about drift operations currently being performed on the StackSet.

For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

See Also:

  • Method Details

    • driftStatus

      public final StackSetDriftStatus driftStatus()

      Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

      • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

      • IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.

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

      Returns:
      Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

      • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

      • IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.

      See Also:

    • driftStatusAsString

      public final String driftStatusAsString()

      Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

      • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

      • IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.

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

      Returns:
      Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

      • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

      • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

      • IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.

      See Also:

    • driftDetectionStatus

      public final StackSetDriftDetectionStatus driftDetectionStatus()

      The status of the StackSet drift detection operation.

      • COMPLETED: The drift detection operation completed without failing on any stack instances.

      • FAILED: The drift detection operation exceeded the specified failure tolerance.

      • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

      • IN_PROGRESS: The drift detection operation is currently being performed.

      • STOPPED: The user has canceled the drift detection operation.

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

      Returns:
      The status of the StackSet drift detection operation.

      • COMPLETED: The drift detection operation completed without failing on any stack instances.

      • FAILED: The drift detection operation exceeded the specified failure tolerance.

      • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

      • IN_PROGRESS: The drift detection operation is currently being performed.

      • STOPPED: The user has canceled the drift detection operation.

      See Also:

    • driftDetectionStatusAsString

      public final String driftDetectionStatusAsString()

      The status of the StackSet drift detection operation.

      • COMPLETED: The drift detection operation completed without failing on any stack instances.

      • FAILED: The drift detection operation exceeded the specified failure tolerance.

      • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

      • IN_PROGRESS: The drift detection operation is currently being performed.

      • STOPPED: The user has canceled the drift detection operation.

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

      Returns:
      The status of the StackSet drift detection operation.

      • COMPLETED: The drift detection operation completed without failing on any stack instances.

      • FAILED: The drift detection operation exceeded the specified failure tolerance.

      • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

      • IN_PROGRESS: The drift detection operation is currently being performed.

      • STOPPED: The user has canceled the drift detection operation.

      See Also:

    • lastDriftCheckTimestamp

      public final Instant lastDriftCheckTimestamp()

      Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

      Returns:
      Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

    • totalStackInstancesCount

      public final Integer totalStackInstancesCount()

      The total number of stack instances belonging to this StackSet.

      The total number of stack instances is equal to the total of:

      • Stack instances that match the StackSet configuration.

      • Stack instances that have drifted from the StackSet configuration.

      • Stack instances where the drift detection operation has failed.

      • Stack instances currently being checked for drift.

      Returns:
      The total number of stack instances belonging to this StackSet.

      The total number of stack instances is equal to the total of:

      • Stack instances that match the StackSet configuration.

      • Stack instances that have drifted from the StackSet configuration.

      • Stack instances where the drift detection operation has failed.

      • Stack instances currently being checked for drift.

    • driftedStackInstancesCount

      public final Integer driftedStackInstancesCount()

      The number of stack instances that have drifted from the expected template and parameter configuration of the StackSet. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

      Returns:
      The number of stack instances that have drifted from the expected template and parameter configuration of the StackSet. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

    • inSyncStackInstancesCount

      public final Integer inSyncStackInstancesCount()

      The number of stack instances which match the expected template and parameter configuration of the StackSet.

      Returns:
      The number of stack instances which match the expected template and parameter configuration of the StackSet.

    • inProgressStackInstancesCount

      public final Integer inProgressStackInstancesCount()

      The number of stack instances that are currently being checked for drift.

      Returns:
      The number of stack instances that are currently being checked for drift.

    • failedStackInstancesCount

      public final Integer failedStackInstancesCount()

      The number of stack instances for which the drift detection operation failed.

      Returns:
      The number of stack instances for which the drift detection operation failed.

    • toBuilder

      public StackSetDriftDetectionDetails.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<StackSetDriftDetectionDetails.Builder,StackSetDriftDetectionDetails>
      Returns:
      a builder for type T

    • builder

      public static StackSetDriftDetectionDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StackSetDriftDetectionDetails.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.