Class StackInstanceResourceDriftsSummary

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

The structure containing summary information about resource drifts for a stack instance.

See Also:

  • Method Details

    • stackId

      public final String stackId()

      The ID of the stack instance.

      Returns:
      The ID of the stack instance.

    • 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()

      Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

      Returns:
      Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    • 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()

      Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus 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:
      Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus is MODIFIED.

    • stackResourceDriftStatus

      public final StackResourceDriftStatus stackResourceDriftStatus()

      The drift status of the resource in a stack instance.

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

      • MODIFIED: One or more resource properties differ from their expected template values.

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

      • NOT_CHECKED: CloudFormation doesn't 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:
      The drift status of the resource in a stack instance.

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

      • MODIFIED: One or more resource properties differ from their expected template values.

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

      • NOT_CHECKED: CloudFormation doesn't currently return this value.

      See Also:

    • stackResourceDriftStatusAsString

      public final String stackResourceDriftStatusAsString()

      The drift status of the resource in a stack instance.

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

      • MODIFIED: One or more resource properties differ from their expected template values.

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

      • NOT_CHECKED: CloudFormation doesn't 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:
      The drift status of the resource in a stack instance.

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

      • MODIFIED: One or more resource properties differ from their expected template values.

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

      • NOT_CHECKED: CloudFormation doesn't currently return this value.

      See Also:

    • timestamp

      public final Instant timestamp()

      Time at which the stack instance drift detection operation was initiated.

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

    • toBuilder

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

    • builder

      public static StackInstanceResourceDriftsSummary.Builder builder()

    • serializableBuilderClass

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