Interface StackInstanceSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StackInstanceSummary.Builder,
,StackInstanceSummary> SdkBuilder<StackInstanceSummary.Builder,
,StackInstanceSummary> SdkPojo
- Enclosing class:
StackInstanceSummary
-
Method Summary
Modifier and TypeMethodDescription[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.driftStatus
(String 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.driftStatus
(StackDriftStatus 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.lastDriftCheckTimestamp
(Instant lastDriftCheckTimestamp) Most recent time when CloudFormation performed a drift detection operation on the stack instance.lastOperationId
(String lastOperationId) The last unique ID of a StackSet operation performed on a stack instance.organizationalUnitId
(String organizationalUnitId) [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.The name of the Amazon Web Services Region that the stack instance is associated with.The ID of the stack instance.default StackInstanceSummary.Builder
stackInstanceStatus
(Consumer<StackInstanceComprehensiveStatus.Builder> stackInstanceStatus) The detailed status of the stack instance.stackInstanceStatus
(StackInstanceComprehensiveStatus stackInstanceStatus) The detailed status of the stack instance.stackSetId
(String stackSetId) The name or unique ID of the stack set that the stack instance is associated with.The status of the stack instance, in terms of its synchronization with its associated stack set.status
(StackInstanceStatus status) The status of the stack instance, in terms of its synchronization with its associated stack set.statusReason
(String statusReason) The explanation for the specific status code assigned to this stack instance.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stackSetId
The name or unique ID of the stack set that the stack instance is associated with.
- Parameters:
stackSetId
- The name or unique ID of the stack set that the stack instance is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
region
The name of the Amazon Web Services Region that the stack instance is associated with.
- Parameters:
region
- The name of the Amazon Web Services Region that the stack instance is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
account
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
- Parameters:
account
- [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackId
The ID of the stack instance.
- Parameters:
stackId
- The ID of the stack instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
statusReason
The explanation for the specific status code assigned to this stack instance.
- Parameters:
statusReason
- The explanation for the specific status code assigned to this stack instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackInstanceStatus
StackInstanceSummary.Builder stackInstanceStatus(StackInstanceComprehensiveStatus stackInstanceStatus) The detailed status of the stack instance.
- Parameters:
stackInstanceStatus
- The detailed status of the stack instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackInstanceStatus
default StackInstanceSummary.Builder stackInstanceStatus(Consumer<StackInstanceComprehensiveStatus.Builder> stackInstanceStatus) The detailed status of the stack instance.
This is a convenience method that creates an instance of theStackInstanceComprehensiveStatus.Builder
avoiding the need to create one manually viaStackInstanceComprehensiveStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostackInstanceStatus(StackInstanceComprehensiveStatus)
.- Parameters:
stackInstanceStatus
- a consumer that will call methods onStackInstanceComprehensiveStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
organizationalUnitId
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
- Parameters:
organizationalUnitId
- [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
lastDriftCheckTimestamp
- Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will beNULL
for any stack instance on which drift detection hasn't yet been performed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastOperationId
The last unique ID of a StackSet operation performed on a stack instance.
- Parameters:
lastOperationId
- The last unique ID of a StackSet operation performed on a stack instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-