Skip to content

/AWS1/CL_FRMSTACKINSTANCE

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_STACKSETID TYPE /AWS1/FRMSTACKSETID /AWS1/FRMSTACKSETID

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

IV_REGION TYPE /AWS1/FRMREGION /AWS1/FRMREGION

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

IV_ACCOUNT TYPE /AWS1/FRMACCOUNT /AWS1/FRMACCOUNT

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

IV_STACKID TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID

The ID of the stack instance.

IT_PARAMETEROVERRIDES TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS

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

IV_STATUS TYPE /AWS1/FRMSTACKINSTANCESTATUS /AWS1/FRMSTACKINSTANCESTATUS

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.

IO_STACKINSTANCESTATUS TYPE REF TO /AWS1/CL_FRMSTACKINSTCOMPREH00 /AWS1/CL_FRMSTACKINSTCOMPREH00

The detailed status of the stack instance.

IV_STATUSREASON TYPE /AWS1/FRMREASON /AWS1/FRMREASON

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

IV_ORGANIZATIONALUNITID TYPE /AWS1/FRMORGANIZATIONALUNITID /AWS1/FRMORGANIZATIONALUNITID

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

IV_DRIFTSTATUS TYPE /AWS1/FRMSTACKDRIFTSTATUS /AWS1/FRMSTACKDRIFTSTATUS

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.

IV_LASTDRIFTCHECKTIMESTAMP TYPE /AWS1/FRMTIMESTAMP /AWS1/FRMTIMESTAMP

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.

IV_LASTOPERATIONID TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

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

Queryable Attributes

StackSetId

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

Accessible with the following methods

Method Description
GET_STACKSETID() Getter for STACKSETID, with configurable default
ASK_STACKSETID() Getter for STACKSETID w/ exceptions if field has no value
HAS_STACKSETID() Determine if STACKSETID has a value

Region

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

Accessible with the following methods

Method Description
GET_REGION() Getter for REGION, with configurable default
ASK_REGION() Getter for REGION w/ exceptions if field has no value
HAS_REGION() Determine if REGION has a value

Account

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

Accessible with the following methods

Method Description
GET_ACCOUNT() Getter for ACCOUNT, with configurable default
ASK_ACCOUNT() Getter for ACCOUNT w/ exceptions if field has no value
HAS_ACCOUNT() Determine if ACCOUNT has a value

StackId

The ID of the stack instance.

Accessible with the following methods

Method Description
GET_STACKID() Getter for STACKID, with configurable default
ASK_STACKID() Getter for STACKID w/ exceptions if field has no value
HAS_STACKID() Determine if STACKID has a value

ParameterOverrides

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

Accessible with the following methods

Method Description
GET_PARAMETEROVERRIDES() Getter for PARAMETEROVERRIDES, with configurable default
ASK_PARAMETEROVERRIDES() Getter for PARAMETEROVERRIDES w/ exceptions if field has no
HAS_PARAMETEROVERRIDES() Determine if PARAMETEROVERRIDES has a value

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

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

StackInstanceStatus

The detailed status of the stack instance.

Accessible with the following methods

Method Description
GET_STACKINSTANCESTATUS() Getter for STACKINSTANCESTATUS

StatusReason

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

Accessible with the following methods

Method Description
GET_STATUSREASON() Getter for STATUSREASON, with configurable default
ASK_STATUSREASON() Getter for STATUSREASON w/ exceptions if field has no value
HAS_STATUSREASON() Determine if STATUSREASON has a value

OrganizationalUnitId

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

Accessible with the following methods

Method Description
GET_ORGANIZATIONALUNITID() Getter for ORGANIZATIONALUNITID, with configurable default
ASK_ORGANIZATIONALUNITID() Getter for ORGANIZATIONALUNITID w/ exceptions if field has n
HAS_ORGANIZATIONALUNITID() Determine if ORGANIZATIONALUNITID has a value

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.

Accessible with the following methods

Method Description
GET_DRIFTSTATUS() Getter for DRIFTSTATUS, with configurable default
ASK_DRIFTSTATUS() Getter for DRIFTSTATUS w/ exceptions if field has no value
HAS_DRIFTSTATUS() Determine if DRIFTSTATUS has a value

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.

Accessible with the following methods

Method Description
GET_LASTDRIFTCHECKTIMESTAMP() Getter for LASTDRIFTCHECKTIMESTAMP, with configurable defaul
ASK_LASTDRIFTCHECKTIMESTAMP() Getter for LASTDRIFTCHECKTIMESTAMP w/ exceptions if field ha
HAS_LASTDRIFTCHECKTIMESTAMP() Determine if LASTDRIFTCHECKTIMESTAMP has a value

LastOperationId

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

Accessible with the following methods

Method Description
GET_LASTOPERATIONID() Getter for LASTOPERATIONID, with configurable default
ASK_LASTOPERATIONID() Getter for LASTOPERATIONID w/ exceptions if field has no val
HAS_LASTOPERATIONID() Determine if LASTOPERATIONID has a value