java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.StackInstanceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackInstanceSummary.Builder,StackInstanceSummary>
```
@Generated("software.amazon.awssdk:codegen")
public final class StackInstanceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackInstanceSummary.Builder,StackInstanceSummary>
```
The structure that contains summary information about a stack instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StackInstanceSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`account()`	[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
`static StackInstanceSummary.Builder`	`builder()`
`StackDriftStatus`	`driftStatus()`	Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
`String`	`driftStatusAsString()`	Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastDriftCheckTimestamp()`	Most recent time when CloudFormation performed a drift detection operation on the stack instance.
`String`	`lastOperationId()`	The last unique ID of a StackSet operation performed on a stack instance.
`String`	`organizationalUnitId()`	[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
`String`	`region()`	The name of the Amazon Web Services Region that the stack instance is associated with.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackInstanceSummary.Builder>`	`serializableBuilderClass()`
`String`	`stackId()`	The ID of the stack instance.
`StackInstanceComprehensiveStatus`	`stackInstanceStatus()`	The detailed status of the stack instance.
`String`	`stackSetId()`	The name or unique ID of the StackSet that the stack instance is associated with.
`StackInstanceStatus`	`status()`	The status of the stack instance, in terms of its synchronization with its associated stack set.
`String`	`statusAsString()`	The status of the stack instance, in terms of its synchronization with its associated stack set.
`String`	`statusReason()`	The explanation for the specific status code assigned to this stack instance.
`StackInstanceSummary.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
  - stackSetId
```
public final String stackSetId()
```
    The name or unique ID of the StackSet that the stack instance is associated with.
    
    Returns:
    
    The name or unique ID of the StackSet 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.
  - account
```
public final String account()
```
    [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
    
    Returns:
    
    [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
  - stackId
```
public final String stackId()
```
    The ID of the stack instance.
    
    Returns:
    
    The ID of the stack instance.
  - status
```
public final StackInstanceStatus status()
```
    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. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.
    
    OUTDATED: The stack isn't currently up to date with the StackSet because:
    
    The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    
    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 StackSet.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.
    
    OUTDATED: The stack isn't currently up to date with the StackSet because:
    
    The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    
    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 StackSet.
    
    See Also:
    
    StackInstanceStatus
  - statusAsString
```
public final String statusAsString()
```
    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. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.
    
    OUTDATED: The stack isn't currently up to date with the StackSet because:
    
    The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    
    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 StackSet.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.
    
    OUTDATED: The stack isn't currently up to date with the StackSet because:
    
    The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    
    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 StackSet.
    
    See Also:
    
    StackInstanceStatus
  - statusReason
```
public final String statusReason()
```
    The explanation for the specific status code assigned to this stack instance.
    
    Returns:
    
    The explanation for the specific status code assigned to this stack instance.
  - stackInstanceStatus
```
public final StackInstanceComprehensiveStatus stackInstanceStatus()
```
    The detailed status of the stack instance.
    
    Returns:
    
    The detailed status of the stack instance.
  - organizationalUnitId
```
public final String organizationalUnitId()
```
    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
    
    Returns:
    
    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
  - driftStatus
```
public final StackDriftStatus driftStatus()
```
    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
    
    DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    
    NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    
    IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.
    
    UNKNOWN: This value is reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, driftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driftStatusAsString().
    Returns:
    
    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
    
    DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    
    NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    
    IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.
    
    UNKNOWN: This value is reserved for future use.
    
    See Also:
    
    StackDriftStatus
  - driftStatusAsString
```
public final String driftStatusAsString()
```
    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
    
    DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    
    NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    
    IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.
    
    UNKNOWN: This value is reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, driftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driftStatusAsString().
    Returns:
    
    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.
    
    DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    
    NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    
    IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.
    
    UNKNOWN: This value is reserved for future use.
    
    See Also:
    
    StackDriftStatus
  - lastDriftCheckTimestamp
```
public final Instant lastDriftCheckTimestamp()
```
    Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.
    
    Returns:
    
    Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.
  - lastOperationId
```
public final String lastOperationId()
```
    The last unique ID of a StackSet operation performed on a stack instance.
    
    Returns:
    
    The last unique ID of a StackSet operation performed on a stack instance.
  - toBuilder
```
public StackInstanceSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackInstanceSummary.Builder,StackInstanceSummary>
  - builder
```
public static StackInstanceSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StackInstanceSummary.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StackInstanceSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

stackSetId

region

account

stackId

status

statusAsString

statusReason

stackInstanceStatus

organizationalUnitId

driftStatus

driftStatusAsString

lastDriftCheckTimestamp

lastOperationId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField