Skip to content

StackInstanceSummary

Source code in docs_src/capo_cloudformation/types/stack_instance_summary.py
class StackInstanceSummary(TypedDict, closed=True):
    stack_set_id: NotRequired["capo_cloudformation.types.stack_set_id.StackSetId"]
    """<p>The name or unique ID of the StackSet that the stack instance is associated with.</p>"""
    region: NotRequired["capo_cloudformation.types.region.Region"]
    """<p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>"""
    account: NotRequired["capo_cloudformation.types.account.Account"]
    """<p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>"""
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The ID of the stack instance.</p>"""
    status: NotRequired[
        "capo_cloudformation.types.stack_instance_status.StackInstanceStatus"
    ]
    """<p>The status of the stack instance, in terms of its synchronization with its associated stack set.</p> <ul> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually. <code>INOPERABLE</code> 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 <a>DescribeStackInstance</a> API operation, look at the <code>DetailedStatus</code> member returned in the <code>StackInstanceSummary</code> member.</p> </li> <li> <p> <code>OUTDATED</code>: The stack isn't currently up to date with the StackSet because:</p> <ul> <li> <p>The associated stack failed during a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation.</p> </li> <li> <p>The stack was part of a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation that failed or was stopped before the stack was created or updated.</p> </li> </ul> </li> <li> <p> <code>CURRENT</code>: The stack is currently up to date with the StackSet.</p> </li> </ul>"""
    status_reason: NotRequired["capo_cloudformation.types.reason.Reason"]
    """<p>The explanation for the specific status code assigned to this stack instance.</p>"""
    stack_instance_status: NotRequired[
        "capo_cloudformation.types.stack_instance_comprehensive_status.StackInstanceComprehensiveStatus"
    ]
    """<p>The detailed status of the stack instance.</p>"""
    organizational_unit_id: NotRequired[
        "capo_cloudformation.types.organizational_unit_id.OrganizationalUnitId"
    ]
    """<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>"""
    drift_status: NotRequired[
        "capo_cloudformation.types.stack_drift_status.StackDriftStatus"
    ]
    """<p>Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack instance's actual configuration matches its expected StackSet configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>"""
    last_drift_check_timestamp: NotRequired[
        "capo_cloudformation.types.timestamp.Timestamp"
    ]
    """<p>Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be <code>NULL</code> for any stack instance that drift detection hasn't yet been performed on.</p>"""
    last_operation_id: NotRequired[
        "capo_cloudformation.types.client_request_token.ClientRequestToken"
    ]
    """<p>The last unique ID of a StackSet operation performed on a stack instance.</p>"""

account instance-attribute

account: NotRequired[Account]

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

drift_status instance-attribute

drift_status: NotRequired[StackDriftStatus]

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. 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 StackSet configuration.

  • IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.

  • UNKNOWN: This value is reserved for future use.

last_drift_check_timestamp instance-attribute

last_drift_check_timestamp: NotRequired[Timestamp]

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.

last_operation_id instance-attribute

last_operation_id: NotRequired[ClientRequestToken]

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

organizational_unit_id instance-attribute

organizational_unit_id: NotRequired[OrganizationalUnitId]

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

region instance-attribute

region: NotRequired[Region]

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

stack_id instance-attribute

stack_id: NotRequired[StackId]

The ID of the stack instance.

stack_instance_status instance-attribute

stack_instance_status: NotRequired[StackInstanceComprehensiveStatus]

The detailed status of the stack instance.

stack_set_id instance-attribute

stack_set_id: NotRequired[StackSetId]

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

status instance-attribute

status: NotRequired[StackInstanceStatus]

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, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.

  • OUTDATED: The stack isn't currently up to date with the StackSet 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 StackSet.

status_reason instance-attribute

status_reason: NotRequired[Reason]

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