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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StackInstance.Builder

Method Summary

Modifier and Type	Method	Description
String	account()	The name of the Amazon Web Services account that the stack instance is associated with.
static StackInstance.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region()	The name of the Amazon Web Services Region that the stack instance is associated with.
List<SdkField<?>>	sdkFields()
static Class<? extends StackInstance.Builder>	serializableBuilderClass()
StackInstanceStatus	stackInstanceStatus()	The status of the stack instance, in terms of its synchronization with its associated stack set.
String	stackInstanceStatusAsString()	The status of the stack instance, in terms of its synchronization with its associated stack set.
StackInstance.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

StackInstanceStatus

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:

StackInstanceStatus

toBuilder

public StackInstance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StackInstance.Builder,StackInstance>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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