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

Class StackResourceDrift

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

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

See Also:

  • Method Details

    • stackId

      public final String stackId()

      The ID of the stack.

      Returns:
      The ID of the stack.

    • logicalResourceId

      public final String logicalResourceId()

      The logical name of the resource specified in the template.

      Returns:
      The logical name of the resource specified in the template.

    • physicalResourceId

      public final String physicalResourceId()

      The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

      Returns:
      The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    • hasPhysicalResourceIdContext

      public final boolean hasPhysicalResourceIdContext()
      For responses, this returns true if the service returned a value for the PhysicalResourceIdContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • physicalResourceIdContext

      public final List<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext()

      Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPhysicalResourceIdContext() method.

      Returns:
      Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

    • resourceType

      public final String resourceType()

      The type of the resource.

      Returns:
      The type of the resource.

    • expectedProperties

      public final String expectedProperties()

      A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

      Returns:
      A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

    • actualProperties

      public final String actualProperties()

      A JSON structure containing the actual property values of the stack resource.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

      Returns:
      A JSON structure containing the actual property values of the stack resource.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

    • hasPropertyDifferences

      public final boolean hasPropertyDifferences()
      For responses, this returns true if the service returned a value for the PropertyDifferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • propertyDifferences

      public final List<PropertyDifference> propertyDifferences()

      A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPropertyDifferences() method.

      Returns:
      A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

    • stackResourceDriftStatus

      public final StackResourceDriftStatus stackResourceDriftStatus()

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

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

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

      • NOT_CHECKED: CloudFormation does not currently return this value.

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

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

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

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

      • NOT_CHECKED: CloudFormation does not currently return this value.

      See Also:

    • stackResourceDriftStatusAsString

      public final String stackResourceDriftStatusAsString()

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

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

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

      • NOT_CHECKED: CloudFormation does not currently return this value.

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

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

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

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

      • NOT_CHECKED: CloudFormation does not currently return this value.

      See Also:

    • timestamp

      public final Instant timestamp()

      Time at which CloudFormation performed drift detection on the stack resource.

      Returns:
      Time at which CloudFormation performed drift detection on the stack resource.

    • moduleInfo

      public final ModuleInfo moduleInfo()

      Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

      Returns:
      Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    • toBuilder

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

    • builder

      public static StackResourceDrift.Builder builder()

    • serializableBuilderClass

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