A 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, in addition to the ID of the actual stack and the stack status.

Constructor & Destructor Documentation

◆ StackInstance() [1/2]

AWS_CLOUDFORMATION_API Aws::CloudFormation::Model::StackInstance::StackInstance ( )

default

◆ StackInstance() [2/2]

AWS_CLOUDFORMATION_API Aws::CloudFormation::Model::StackInstance::StackInstance ( const Aws::Utils::Xml::XmlNode & xmlNode)

Member Function Documentation

◆ AccountHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::AccountHasBeenSet ( ) const

inline

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

Definition at line 86 of file StackInstance.h.

◆ AddParameterOverrides()

template<typename ParameterOverridesT = Parameter>

StackInstance & Aws::CloudFormation::Model::StackInstance::AddParameterOverrides ( ParameterOverridesT && value)

inline

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Definition at line 117 of file StackInstance.h.

◆ DriftStatusHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::DriftStatusHasBeenSet ( ) const

inline

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.

Definition at line 203 of file StackInstance.h.

◆ GetAccount()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetAccount ( ) const

inline

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

Definition at line 85 of file StackInstance.h.

◆ GetDriftStatus()

StackDriftStatus Aws::CloudFormation::Model::StackInstance::GetDriftStatus ( ) const

inline

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.

Definition at line 202 of file StackInstance.h.

◆ GetLastDriftCheckTimestamp()

const Aws::Utils::DateTime & Aws::CloudFormation::Model::StackInstance::GetLastDriftCheckTimestamp ( ) const

inline

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.

Definition at line 214 of file StackInstance.h.

◆ GetLastOperationId()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetLastOperationId ( ) const

inline

The last unique ID of a StackSet operation performed on a stack instance.

Definition at line 226 of file StackInstance.h.

◆ GetOrganizationalUnitId()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetOrganizationalUnitId ( ) const

inline

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Definition at line 180 of file StackInstance.h.

◆ GetParameterOverrides()

const Aws::Vector< Parameter > & Aws::CloudFormation::Model::StackInstance::GetParameterOverrides ( ) const

inline

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Definition at line 110 of file StackInstance.h.

◆ GetRegion()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetRegion ( ) const

inline

The name of the Amazon Web Services Region that the stack instance is associated with.

Definition at line 72 of file StackInstance.h.

◆ GetStackId()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetStackId ( ) const

inline

The ID of the stack instance.

Definition at line 97 of file StackInstance.h.

◆ GetStackInstanceStatus()

const StackInstanceComprehensiveStatus & Aws::CloudFormation::Model::StackInstance::GetStackInstanceStatus ( ) const

inline

The detailed status of the stack instance.

Definition at line 153 of file StackInstance.h.

◆ GetStackSetId()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetStackSetId ( ) const

inline

The name or unique ID of the stack set that the stack instance is associated with.

Definition at line 59 of file StackInstance.h.

◆ GetStatus()

StackInstanceStatus Aws::CloudFormation::Model::StackInstance::GetStatus ( ) const

inline

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, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.
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.

Definition at line 143 of file StackInstance.h.

◆ GetStatusReason()

const Aws::String & Aws::CloudFormation::Model::StackInstance::GetStatusReason ( ) const

inline

The explanation for the specific status code that's assigned to this stack instance.

Definition at line 166 of file StackInstance.h.

◆ LastDriftCheckTimestampHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::LastDriftCheckTimestampHasBeenSet ( ) const

inline

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.

Definition at line 215 of file StackInstance.h.

◆ LastOperationIdHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::LastOperationIdHasBeenSet ( ) const

inline

The last unique ID of a StackSet operation performed on a stack instance.

Definition at line 227 of file StackInstance.h.

◆ operator=()

AWS_CLOUDFORMATION_API StackInstance & Aws::CloudFormation::Model::StackInstance::operator= ( const Aws::Utils::Xml::XmlNode & xmlNode)

◆ OrganizationalUnitIdHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::OrganizationalUnitIdHasBeenSet ( ) const

inline

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Definition at line 181 of file StackInstance.h.

◆ OutputToStream() [1/2]

AWS_CLOUDFORMATION_API void Aws::CloudFormation::Model::StackInstance::OutputToStream ( Aws::OStream & oStream,

const char * location

) const

◆ OutputToStream() [2/2]

AWS_CLOUDFORMATION_API void Aws::CloudFormation::Model::StackInstance::OutputToStream ( Aws::OStream & ostream,

const char * location,

unsigned index,

const char * locationValue

) const

◆ ParameterOverridesHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::ParameterOverridesHasBeenSet ( ) const

inline

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Definition at line 111 of file StackInstance.h.

◆ RegionHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::RegionHasBeenSet ( ) const

inline

The name of the Amazon Web Services Region that the stack instance is associated with.

Definition at line 73 of file StackInstance.h.

◆ SetAccount()

template<typename AccountT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetAccount ( AccountT && value)

inline

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

Definition at line 88 of file StackInstance.h.

◆ SetDriftStatus()

void Aws::CloudFormation::Model::StackInstance::SetDriftStatus ( StackDriftStatus value)

inline

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.

Definition at line 204 of file StackInstance.h.

◆ SetLastDriftCheckTimestamp()

template<typename LastDriftCheckTimestampT = Aws::Utils::DateTime>

void Aws::CloudFormation::Model::StackInstance::SetLastDriftCheckTimestamp ( LastDriftCheckTimestampT && value)

inline

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.

Definition at line 217 of file StackInstance.h.

◆ SetLastOperationId()

template<typename LastOperationIdT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetLastOperationId ( LastOperationIdT && value)

inline

The last unique ID of a StackSet operation performed on a stack instance.

Definition at line 229 of file StackInstance.h.

◆ SetOrganizationalUnitId()

template<typename OrganizationalUnitIdT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetOrganizationalUnitId ( OrganizationalUnitIdT && value)

inline

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Definition at line 183 of file StackInstance.h.

◆ SetParameterOverrides()

template<typename ParameterOverridesT = Aws::Vector<Parameter>>

void Aws::CloudFormation::Model::StackInstance::SetParameterOverrides ( ParameterOverridesT && value)

inline

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Definition at line 113 of file StackInstance.h.

◆ SetRegion()

template<typename RegionT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetRegion ( RegionT && value)

inline

The name of the Amazon Web Services Region that the stack instance is associated with.

Definition at line 75 of file StackInstance.h.

◆ SetStackId()

template<typename StackIdT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetStackId ( StackIdT && value)

inline

The ID of the stack instance.

Definition at line 100 of file StackInstance.h.

◆ SetStackInstanceStatus()

template<typename StackInstanceStatusT = StackInstanceComprehensiveStatus>

void Aws::CloudFormation::Model::StackInstance::SetStackInstanceStatus ( StackInstanceStatusT && value)

inline

The detailed status of the stack instance.

Definition at line 156 of file StackInstance.h.

◆ SetStackSetId()

template<typename StackSetIdT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetStackSetId ( StackSetIdT && value)

inline

The name or unique ID of the stack set that the stack instance is associated with.

Definition at line 62 of file StackInstance.h.

◆ SetStatus()

void Aws::CloudFormation::Model::StackInstance::SetStatus ( StackInstanceStatus value)

inline

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, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.
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.

Definition at line 145 of file StackInstance.h.

◆ SetStatusReason()

template<typename StatusReasonT = Aws::String>

void Aws::CloudFormation::Model::StackInstance::SetStatusReason ( StatusReasonT && value)

inline

The explanation for the specific status code that's assigned to this stack instance.

Definition at line 169 of file StackInstance.h.

◆ StackIdHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::StackIdHasBeenSet ( ) const

inline

The ID of the stack instance.

Definition at line 98 of file StackInstance.h.

◆ StackInstanceStatusHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::StackInstanceStatusHasBeenSet ( ) const

inline

The detailed status of the stack instance.

Definition at line 154 of file StackInstance.h.

◆ StackSetIdHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::StackSetIdHasBeenSet ( ) const

inline

The name or unique ID of the stack set that the stack instance is associated with.

Definition at line 60 of file StackInstance.h.

◆ StatusHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::StatusHasBeenSet ( ) const

inline

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, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.
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.

Definition at line 144 of file StackInstance.h.

◆ StatusReasonHasBeenSet()

bool Aws::CloudFormation::Model::StackInstance::StatusReasonHasBeenSet ( ) const

inline

The explanation for the specific status code that's assigned to this stack instance.

Definition at line 167 of file StackInstance.h.

◆ WithAccount()

template<typename AccountT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithAccount ( AccountT && value)

inline

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

Definition at line 90 of file StackInstance.h.

◆ WithDriftStatus()

StackInstance & Aws::CloudFormation::Model::StackInstance::WithDriftStatus ( StackDriftStatus value)

inline

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.

Definition at line 205 of file StackInstance.h.

◆ WithLastDriftCheckTimestamp()

template<typename LastDriftCheckTimestampT = Aws::Utils::DateTime>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithLastDriftCheckTimestamp ( LastDriftCheckTimestampT && value)

inline

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.

Definition at line 219 of file StackInstance.h.

◆ WithLastOperationId()

template<typename LastOperationIdT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithLastOperationId ( LastOperationIdT && value)

inline

The last unique ID of a StackSet operation performed on a stack instance.

Definition at line 231 of file StackInstance.h.

◆ WithOrganizationalUnitId()

template<typename OrganizationalUnitIdT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithOrganizationalUnitId ( OrganizationalUnitIdT && value)

inline

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Definition at line 185 of file StackInstance.h.

◆ WithParameterOverrides()

template<typename ParameterOverridesT = Aws::Vector<Parameter>>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithParameterOverrides ( ParameterOverridesT && value)

inline

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Definition at line 115 of file StackInstance.h.

◆ WithRegion()

template<typename RegionT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithRegion ( RegionT && value)

inline

The name of the Amazon Web Services Region that the stack instance is associated with.

Definition at line 77 of file StackInstance.h.

◆ WithStackId()

template<typename StackIdT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithStackId ( StackIdT && value)

inline

The ID of the stack instance.

Definition at line 102 of file StackInstance.h.

◆ WithStackInstanceStatus()

template<typename StackInstanceStatusT = StackInstanceComprehensiveStatus>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithStackInstanceStatus ( StackInstanceStatusT && value)

inline

The detailed status of the stack instance.

Definition at line 158 of file StackInstance.h.

◆ WithStackSetId()

template<typename StackSetIdT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithStackSetId ( StackSetIdT && value)

inline

The name or unique ID of the stack set that the stack instance is associated with.

Definition at line 64 of file StackInstance.h.

◆ WithStatus()

StackInstance & Aws::CloudFormation::Model::StackInstance::WithStatus ( StackInstanceStatus value)

inline

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, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.
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.

Definition at line 146 of file StackInstance.h.

◆ WithStatusReason()

template<typename StatusReasonT = Aws::String>

StackInstance & Aws::CloudFormation::Model::StackInstance::WithStatusReason ( StatusReasonT && value)

inline

The explanation for the specific status code that's assigned to this stack instance.

Definition at line 171 of file StackInstance.h.

The documentation for this class was generated from the following file:

generated/src/aws-cpp-sdk-cloudformation/include/aws/cloudformation/model/StackInstance.h

AWS SDK for C++

AWS SDK for C++ Version 1.11.619

Public Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ StackInstance() [1/2]

◆ StackInstance() [2/2]

Member Function Documentation

◆ AccountHasBeenSet()

◆ AddParameterOverrides()

◆ DriftStatusHasBeenSet()

◆ GetAccount()

◆ GetDriftStatus()

◆ GetLastDriftCheckTimestamp()

◆ GetLastOperationId()

◆ GetOrganizationalUnitId()

◆ GetParameterOverrides()

◆ GetRegion()

◆ GetStackId()

◆ GetStackInstanceStatus()

◆ GetStackSetId()

◆ GetStatus()

◆ GetStatusReason()

◆ LastDriftCheckTimestampHasBeenSet()

◆ LastOperationIdHasBeenSet()

◆ operator=()

◆ OrganizationalUnitIdHasBeenSet()

◆ OutputToStream() [1/2]

◆ OutputToStream() [2/2]

◆ ParameterOverridesHasBeenSet()

◆ RegionHasBeenSet()

◆ SetAccount()

◆ SetDriftStatus()

◆ SetLastDriftCheckTimestamp()

◆ SetLastOperationId()

◆ SetOrganizationalUnitId()

◆ SetParameterOverrides()

◆ SetRegion()

◆ SetStackId()

◆ SetStackInstanceStatus()

◆ SetStackSetId()

◆ SetStatus()

◆ SetStatusReason()

◆ StackIdHasBeenSet()

◆ StackInstanceStatusHasBeenSet()

◆ StackSetIdHasBeenSet()

◆ StatusHasBeenSet()

◆ StatusReasonHasBeenSet()

◆ WithAccount()

◆ WithDriftStatus()

◆ WithLastDriftCheckTimestamp()

◆ WithLastOperationId()

◆ WithOrganizationalUnitId()

◆ WithParameterOverrides()

◆ WithRegion()

◆ WithStackId()

◆ WithStackInstanceStatus()

◆ WithStackSetId()

◆ WithStatus()

◆ WithStatusReason()