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

Class StackSummary

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

The StackSummary Data Type

See Also:

  • Method Details

    • stackId

      public final String stackId()

      Unique stack identifier.

      Returns:
      Unique stack identifier.

    • stackName

      public final String stackName()

      The name associated with the stack.

      Returns:
      The name associated with the stack.

    • templateDescription

      public final String templateDescription()

      The template description of the template used to create the stack.

      Returns:
      The template description of the template used to create the stack.

    • creationTime

      public final Instant creationTime()

      The time the stack was created.

      Returns:
      The time the stack was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

      Returns:
      The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

    • deletionTime

      public final Instant deletionTime()

      The time the stack was deleted.

      Returns:
      The time the stack was deleted.

    • stackStatus

      public final StackStatus stackStatus()

      The current status of the stack.

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

      Returns:
      The current status of the stack.
      See Also:

    • stackStatusAsString

      public final String stackStatusAsString()

      The current status of the stack.

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

      Returns:
      The current status of the stack.
      See Also:

    • stackStatusReason

      public final String stackStatusReason()

      Success/Failure message associated with the stack status.

      Returns:
      Success/Failure message associated with the stack status.

    • parentId

      public final String parentId()

      For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

      Returns:
      For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

    • rootId

      public final String rootId()

      For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

      Returns:
      For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

    • driftInformation

      public final StackDriftInformationSummary driftInformation()

      Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

      Returns:
      Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

    • toBuilder

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

    • builder

      public static StackSummary.Builder builder()

    • serializableBuilderClass

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