@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StackInstance extends Object implements Serializable, Cloneable
An AWS 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.
Constructor and Description |
---|
StackInstance() |
Modifier and Type | Method and Description |
---|---|
StackInstance |
clone() |
boolean |
equals(Object obj) |
String |
getAccount()
The name of the AWS account that the stack instance is associated with.
|
String |
getDriftStatus()
Status of the stack instance's actual configuration compared to the expected template and parameter configuration
of the stack set to which it belongs.
|
Date |
getLastDriftCheckTimestamp()
Most recent time when CloudFormation performed a drift detection operation on the stack instance.
|
List<Parameter> |
getParameterOverrides()
A list of parameters from the stack set template whose values have been overridden in this stack instance.
|
String |
getRegion()
The name of the AWS region that the stack instance is associated with.
|
String |
getStackId()
The ID of the stack instance.
|
String |
getStackSetId()
The name or unique ID of the stack set that the stack instance is associated with.
|
String |
getStatus()
The status of the stack instance, in terms of its synchronization with its associated stack set.
|
String |
getStatusReason()
The explanation for the specific status code that is assigned to this stack instance.
|
int |
hashCode() |
void |
setAccount(String account)
The name of the AWS account that the stack instance is associated with.
|
void |
setDriftStatus(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.
|
void |
setDriftStatus(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.
|
void |
setLastDriftCheckTimestamp(Date lastDriftCheckTimestamp)
Most recent time when CloudFormation performed a drift detection operation on the stack instance.
|
void |
setParameterOverrides(Collection<Parameter> parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
|
void |
setRegion(String region)
The name of the AWS region that the stack instance is associated with.
|
void |
setStackId(String stackId)
The ID of the stack instance.
|
void |
setStackSetId(String stackSetId)
The name or unique ID of the stack set that the stack instance is associated with.
|
void |
setStatus(StackInstanceStatus status)
The status of the stack instance, in terms of its synchronization with its associated stack set.
|
void |
setStatus(String status)
The status of the stack instance, in terms of its synchronization with its associated stack set.
|
void |
setStatusReason(String statusReason)
The explanation for the specific status code that is assigned to this stack instance.
|
String |
toString()
Returns a string representation of this object.
|
StackInstance |
withAccount(String account)
The name of the AWS account that the stack instance is associated with.
|
StackInstance |
withDriftStatus(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.
|
StackInstance |
withDriftStatus(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.
|
StackInstance |
withLastDriftCheckTimestamp(Date lastDriftCheckTimestamp)
Most recent time when CloudFormation performed a drift detection operation on the stack instance.
|
StackInstance |
withParameterOverrides(Collection<Parameter> parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
|
StackInstance |
withParameterOverrides(Parameter... parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
|
StackInstance |
withRegion(String region)
The name of the AWS region that the stack instance is associated with.
|
StackInstance |
withStackId(String stackId)
The ID of the stack instance.
|
StackInstance |
withStackSetId(String stackSetId)
The name or unique ID of the stack set that the stack instance is associated with.
|
StackInstance |
withStatus(StackInstanceStatus status)
The status of the stack instance, in terms of its synchronization with its associated stack set.
|
StackInstance |
withStatus(String status)
The status of the stack instance, in terms of its synchronization with its associated stack set.
|
StackInstance |
withStatusReason(String statusReason)
The explanation for the specific status code that is assigned to this stack instance.
|
public void setStackSetId(String stackSetId)
The name or unique ID of the stack set that the stack instance is associated with.
stackSetId
- The name or unique ID of the stack set that the stack instance is associated with.public String getStackSetId()
The name or unique ID of the stack set that the stack instance is associated with.
public StackInstance withStackSetId(String stackSetId)
The name or unique ID of the stack set that the stack instance is associated with.
stackSetId
- The name or unique ID of the stack set that the stack instance is associated with.public void setRegion(String region)
The name of the AWS region that the stack instance is associated with.
region
- The name of the AWS region that the stack instance is associated with.public String getRegion()
The name of the AWS region that the stack instance is associated with.
public StackInstance withRegion(String region)
The name of the AWS region that the stack instance is associated with.
region
- The name of the AWS region that the stack instance is associated with.public void setAccount(String account)
The name of the AWS account that the stack instance is associated with.
account
- The name of the AWS account that the stack instance is associated with.public String getAccount()
The name of the AWS account that the stack instance is associated with.
public StackInstance withAccount(String account)
The name of the AWS account that the stack instance is associated with.
account
- The name of the AWS account that the stack instance is associated with.public void setStackId(String stackId)
The ID of the stack instance.
stackId
- The ID of the stack instance.public String getStackId()
The ID of the stack instance.
public StackInstance withStackId(String stackId)
The ID of the stack instance.
stackId
- The ID of the stack instance.public List<Parameter> getParameterOverrides()
A list of parameters from the stack set template whose values have been overridden in this stack instance.
public void setParameterOverrides(Collection<Parameter> parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
parameterOverrides
- A list of parameters from the stack set template whose values have been overridden in this stack instance.public StackInstance withParameterOverrides(Parameter... parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
NOTE: This method appends the values to the existing list (if any). Use
setParameterOverrides(java.util.Collection)
or withParameterOverrides(java.util.Collection)
if
you want to override the existing values.
parameterOverrides
- A list of parameters from the stack set template whose values have been overridden in this stack instance.public StackInstance withParameterOverrides(Collection<Parameter> parameterOverrides)
A list of parameters from the stack set template whose values have been overridden in this stack instance.
parameterOverrides
- A list of parameters from the stack set template whose values have been overridden in this stack instance.public void setStatus(String 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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
StackInstanceStatus
public String getStatus()
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:
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 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:
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 stack set.
StackInstanceStatus
public StackInstance withStatus(String 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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
StackInstanceStatus
public void setStatus(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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
StackInstanceStatus
public StackInstance withStatus(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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
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.
OUTDATED
: The stack isn't currently up to date with the stack set 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 stack set.
StackInstanceStatus
public void setStatusReason(String statusReason)
The explanation for the specific status code that is assigned to this stack instance.
statusReason
- The explanation for the specific status code that is assigned to this stack instance.public String getStatusReason()
The explanation for the specific status code that is assigned to this stack instance.
public StackInstance withStatusReason(String statusReason)
The explanation for the specific status code that is assigned to this stack instance.
statusReason
- The explanation for the specific status code that is assigned to this stack instance.public void setDriftStatus(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.
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
: AWS CloudFormation has not 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.
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
: AWS CloudFormation has not 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.
StackDriftStatus
public String getDriftStatus()
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
: AWS CloudFormation has not 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.
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
: AWS CloudFormation has not 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.
StackDriftStatus
public StackInstance withDriftStatus(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.
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
: AWS CloudFormation has not 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.
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
: AWS CloudFormation has not 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.
StackDriftStatus
public void setDriftStatus(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.
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
: AWS CloudFormation has not 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.
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
: AWS CloudFormation has not 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.
StackDriftStatus
public StackInstance withDriftStatus(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.
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
: AWS CloudFormation has not 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.
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
: AWS CloudFormation has not 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.
StackDriftStatus
public void setLastDriftCheckTimestamp(Date 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 has not yet been performed.
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 has not yet been
performed.public Date getLastDriftCheckTimestamp()
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 has not yet been performed.
NULL
for any stack instance on which drift detection has not yet been
performed.public StackInstance withLastDriftCheckTimestamp(Date 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 has not yet been performed.
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 has not yet been
performed.public String toString()
toString
in class Object
Object.toString()
public StackInstance clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.