Skip to content

DescribeStackInstanceInput

Source code in docs_src/capo_cloudformation/types/describe_stack_instance_input.py
class DescribeStackInstanceInput(TypedDict, closed=True):
    stack_set_name: NotRequired["capo_cloudformation.types.stack_set_name.StackSetName"]
    """<p>The name or the unique stack ID of the StackSet that you want to get stack instance information for.</p>"""
    stack_instance_account: NotRequired["capo_cloudformation.types.account.Account"]
    """<p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>"""
    stack_instance_region: NotRequired["capo_cloudformation.types.region.Region"]
    """<p>The name of a Region that's associated with this stack instance.</p>"""
    call_as: NotRequired["capo_cloudformation.types.call_as.CallAs"]
    """<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>"""

call_as instance-attribute

call_as: NotRequired[CallAs]

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

stack_instance_account instance-attribute

stack_instance_account: NotRequired[Account]

The ID of an Amazon Web Services account that's associated with this stack instance.

stack_instance_region instance-attribute

stack_instance_region: NotRequired[Region]

The name of a Region that's associated with this stack instance.

stack_set_name instance-attribute

stack_set_name: NotRequired[StackSetName]

The name or the unique stack ID of the StackSet that you want to get stack instance information for.