Package software.amazon.awssdk.services.servicecatalog.model

Class StackInstance

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

An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

See Also:

  • Method Details

    • account

      public final String account()

      The name of the Amazon Web Services account that the stack instance is associated with.

      Returns:
      The name of the Amazon Web Services account that the stack instance is associated with.

    • region

      public final String region()

      The name of the Amazon Web Services Region that the stack instance is associated with.

      Returns:
      The name of the Amazon Web Services Region that the stack instance is associated with.

    • stackInstanceStatus

      public final StackInstanceStatus stackInstanceStatus()

      The status of the stack instance, in terms of its synchronization with its associated stack set.

      • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      • CURRENT: The stack is currently up to date with the stack set.

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

      Returns:
      The status of the stack instance, in terms of its synchronization with its associated stack set.

      • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      • CURRENT: The stack is currently up to date with the stack set.

      See Also:

    • stackInstanceStatusAsString

      public final String stackInstanceStatusAsString()

      The status of the stack instance, in terms of its synchronization with its associated stack set.

      • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      • CURRENT: The stack is currently up to date with the stack set.

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

      Returns:
      The status of the stack instance, in terms of its synchronization with its associated stack set.

      • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      • CURRENT: The stack is currently up to date with the stack set.

      See Also:

    • toBuilder

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

    • builder

      public static StackInstance.Builder builder()

    • serializableBuilderClass

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