Stack ¶

class Stack(TypedDict, closed=True):
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>Unique identifier of the stack.</p>"""
    stack_name: NotRequired["capo_cloudformation.types.stack_name.StackName"]
    """<p>The name associated with the stack.</p>"""
    change_set_id: NotRequired["capo_cloudformation.types.change_set_id.ChangeSetId"]
    """<p>The unique ID of the change set.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>A user-defined description associated with the stack.</p>"""
    parameters: NotRequired["capo_cloudformation.types.parameters.Parameters"]
    """<p>A list of <code>Parameter</code> structures.</p>"""
    creation_time: NotRequired["capo_cloudformation.types.creation_time.CreationTime"]
    """<p>The time at which the stack was created.</p>"""
    deletion_time: NotRequired["capo_cloudformation.types.deletion_time.DeletionTime"]
    """<p>The time the stack was deleted.</p>"""
    last_updated_time: NotRequired[
        "capo_cloudformation.types.last_updated_time.LastUpdatedTime"
    ]
    """<p>The time the stack was last updated. This field will only be returned if the stack has been updated at least once.</p>"""
    rollback_configuration: NotRequired[
        "capo_cloudformation.types.rollback_configuration.RollbackConfiguration"
    ]
    """<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>"""
    stack_status: NotRequired["capo_cloudformation.types.stack_status.StackStatus"]
    """<p>Current status of the stack.</p>"""
    stack_status_reason: NotRequired[
        "capo_cloudformation.types.stack_status_reason.StackStatusReason"
    ]
    """<p>Success/failure message associated with the stack status.</p>"""
    disable_rollback: NotRequired[
        "capo_cloudformation.types.disable_rollback.DisableRollback"
    ]
    """<p>Boolean to enable or disable rollback on stack creation failures:</p> <ul> <li> <p> <code>true</code>: disable rollback.</p> </li> <li> <p> <code>false</code>: enable rollback.</p> </li> </ul>"""
    deployment_config: NotRequired[
        "capo_cloudformation.types.deployment_config.DeploymentConfig"
    ]
    """<p>The deployment configuration for the stack, including the deployment mode used for stack operations.</p>"""
    notification_ar_ns: NotRequired[
        "capo_cloudformation.types.notification_ar_ns.NotificationARNs"
    ]
    """<p>Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.</p>"""
    timeout_in_minutes: NotRequired[
        "capo_cloudformation.types.timeout_minutes.TimeoutMinutes"
    ]
    """<p>The amount of time within which stack creation should complete.</p>"""
    capabilities: NotRequired["capo_cloudformation.types.capabilities.Capabilities"]
    """<p>The capabilities allowed in the stack.</p>"""
    outputs: NotRequired["capo_cloudformation.types.outputs.Outputs"]
    """<p>A list of output structures.</p>"""
    role_arn: NotRequired["capo_cloudformation.types.role_arn.RoleARN"]
    """<p>The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.</p>"""
    tags: NotRequired["capo_cloudformation.types.tags.Tags"]
    """<p>A list of <code>Tag</code>s that specify information about the stack.</p>"""
    enable_termination_protection: NotRequired[
        "capo_cloudformation.types.enable_termination_protection.EnableTerminationProtection"
    ]
    """<p>Whether termination protection is enabled for the stack.</p> <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protect a CloudFormation stack from being deleted</a> in the <i>CloudFormation User Guide</i>.</p>"""
    parent_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>For nested stacks, the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>"""
    root_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>"""
    drift_information: NotRequired[
        "capo_cloudformation.types.stack_drift_information.StackDriftInformation"
    ]
    """<p>Information about whether a stack's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>"""
    retain_except_on_create: NotRequired[
        "capo_cloudformation.types.retain_except_on_create.RetainExceptOnCreate"
    ]
    """<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>"""
    deletion_mode: NotRequired["capo_cloudformation.types.deletion_mode.DeletionMode"]
    """<p>Specifies the deletion mode for the stack. Possible values are:</p> <ul> <li> <p> <code>STANDARD</code> - Use the standard behavior. Specifying this value is the same as not specifying this parameter.</p> </li> <li> <p> <code>FORCE_DELETE_STACK</code> - Delete the stack if it's stuck in a <code>DELETE_FAILED</code> state due to resource deletion failure.</p> </li> </ul>"""
    detailed_status: NotRequired[
        "capo_cloudformation.types.detailed_status.DetailedStatus"
    ]
    """<p>The detailed status of the resource or stack. If <code>CONFIGURATION_COMPLETE</code> is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The StackSets <code>CONFIGURATION_COMPLETE</code> when all of the resources in the stack have reached that event. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p>"""
    last_operations: NotRequired[
        "capo_cloudformation.types.last_operations.LastOperations"
    ]
    """<p>Information about the most recent operations performed on this stack.</p>"""