Class StackInstanceSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackInstanceSummary.Builder,
StackInstanceSummary>
The structure that contains summary information about a stack instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
account()
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.static StackInstanceSummary.Builder
builder()
final StackDriftStatus
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.final String
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
Most recent time when CloudFormation performed a drift detection operation on the stack instance.final String
The last unique ID of a StackSet operation performed on a stack instance.final String
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.final String
region()
The name of the Amazon Web Services Region that the stack instance is associated with.static Class
<? extends StackInstanceSummary.Builder> final String
stackId()
The ID of the stack instance.The detailed status of the stack instance.final String
The name or unique ID of the stack set that the stack instance is associated with.final StackInstanceStatus
status()
The status of the stack instance, in terms of its synchronization with its associated stack set.final String
The status of the stack instance, in terms of its synchronization with its associated stack set.final String
The explanation for the specific status code assigned to this stack instance.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stackSetId
The name or unique ID of the stack set that the stack instance is associated with.
- Returns:
- The name or unique ID of the stack set that the stack instance is associated with.
-
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
[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
The ID of the stack instance.
- Returns:
- The ID of the stack instance.
-
status
The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, 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 theDetailedStatus
member returned in theStackInstanceSummary
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
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,
status
will returnStackInstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, 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 theDetailedStatus
member returned in theStackInstanceSummary
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
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:
-
-
statusAsString
The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, 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 theDetailedStatus
member returned in theStackInstanceSummary
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
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,
status
will returnStackInstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, 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 theDetailedStatus
member returned in theStackInstanceSummary
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
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:
-
-
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
The detailed status of the stack instance.
- Returns:
- The detailed status of the stack instance.
-
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
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. 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 stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set 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 returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdriftStatusAsString()
.- Returns:
- Status of the stack instance's actual configuration compared to the expected template and parameter
configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. 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 stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set configuration. -
UNKNOWN
: This value is reserved for future use.
-
- See Also:
-
-
driftStatusAsString
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. 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 stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set 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 returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdriftStatusAsString()
.- Returns:
- Status of the stack instance's actual configuration compared to the expected template and parameter
configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. 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 stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set configuration. -
UNKNOWN
: This value is reserved for future use.
-
- See Also:
-
-
lastDriftCheckTimestamp
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be
NULL
for any stack instance on which drift detection hasn't yet been performed.- Returns:
- Most recent time when CloudFormation performed a drift detection operation on the stack instance. This
value will be
NULL
for any stack instance on which drift detection hasn't yet been performed.
-
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
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 interfaceToCopyableBuilder<StackInstanceSummary.Builder,
StackInstanceSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-