Documentation

An 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.

See: newStackInstance smart constructor.

Create a value of StackInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:account:StackInstance', stackInstance_account - [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

$sel:driftStatus:StackInstance', stackInstance_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.

$sel:lastDriftCheckTimestamp:StackInstance', stackInstance_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.

$sel:lastOperationId:StackInstance', stackInstance_lastOperationId - The last unique ID of a StackSet operation performed on a stack instance.

$sel:organizationalUnitId:StackInstance', stackInstance_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

$sel:parameterOverrides:StackInstance', stackInstance_parameterOverrides - A list of parameters from the stack set template whose values have been overridden in this stack instance.

$sel:region:StackInstance', stackInstance_region - The name of the Amazon Web Services Region that the stack instance is associated with.

$sel:stackId:StackInstance', stackInstance_stackId - The ID of the stack instance.

$sel:stackInstanceStatus:StackInstance', stackInstance_stackInstanceStatus - The detailed status of the stack instance.

$sel:stackSetId:StackInstance', stackInstance_stackSetId - The name or unique ID of the stack set that the stack instance is associated with.

$sel:status:StackInstance', stackInstance_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.

$sel:statusReason:StackInstance', stackInstance_statusReason - The explanation for the specific status code that's assigned to this stack instance.

Self-managed permissions

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

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.

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.

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

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

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

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

The ID of the stack instance.

The detailed status of the stack instance.

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.

• 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.

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