Stack¶
Structure Class¶
Stack
dataclass
¶
Bases: _SerdeShape
The Stack data type.
Attributes¶
capabilities
class-attribute
instance-attribute
¶
The capabilities allowed in the stack.
change_set_id
class-attribute
instance-attribute
¶
change_set_id: str | None = ...
The unique ID of the change set.
creation_time
class-attribute
instance-attribute
¶
creation_time: datetime | None = ...
The time at which the stack was created.
deletion_mode
class-attribute
instance-attribute
¶
deletion_mode: str | None = ...
Specifies the deletion mode for the stack. Possible values are:
-
STANDARD- Use the standard behavior. Specifying this value is the same as not specifying this parameter. -
FORCE_DELETE_STACK- Delete the stack if it's stuck in aDELETE_FAILEDstate due to resource deletion failure.
deletion_time
class-attribute
instance-attribute
¶
deletion_time: datetime | None = ...
The time the stack was deleted.
deployment_config
class-attribute
instance-attribute
¶
deployment_config: DeploymentConfig | None = ...
The deployment configuration for the stack, including the deployment mode used for stack operations.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A user-defined description associated with the stack.
detailed_status
class-attribute
instance-attribute
¶
detailed_status: str | None = ...
The detailed status of the resource or stack. If
CONFIGURATION_COMPLETE is present, the resource or resource
configuration phase has completed and the stabilization of the resources
is in progress. The StackSets CONFIGURATION_COMPLETE when all of the
resources in the stack have reached that event. For more information,
see Understand CloudFormation stack creation
events
in the CloudFormation User Guide.
disable_rollback
class-attribute
instance-attribute
¶
disable_rollback: bool | None = ...
Boolean to enable or disable rollback on stack creation failures:
-
true: disable rollback. -
false: enable rollback.
drift_information
class-attribute
instance-attribute
¶
drift_information: StackDriftInformation | None = ...
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
enable_termination_protection
class-attribute
instance-attribute
¶
enable_termination_protection: bool | None = ...
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
last_operations
class-attribute
instance-attribute
¶
last_operations: list[OperationEntry] | None = ...
Information about the most recent operations performed on this stack.
last_updated_time
class-attribute
instance-attribute
¶
last_updated_time: datetime | None = ...
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
notification_ar_ns
class-attribute
instance-attribute
¶
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
outputs
class-attribute
instance-attribute
¶
A list of output structures.
parameters
class-attribute
instance-attribute
¶
A list of Parameter structures.
parent_id
class-attribute
instance-attribute
¶
parent_id: str | None = ...
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.
For more information, see Nested stacks in the CloudFormation User Guide.
retain_except_on_create
class-attribute
instance-attribute
¶
retain_except_on_create: bool | None = ...
When set to true, newly created resources are deleted when the
operation rolls back. This includes newly created resources marked with
a deletion policy of Retain.
Default: false
role_arn
class-attribute
instance-attribute
¶
role_arn: str | None = ...
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.
rollback_configuration
class-attribute
instance-attribute
¶
rollback_configuration: RollbackConfiguration | None = ...
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
root_id
class-attribute
instance-attribute
¶
root_id: str | None = ...
For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Nested stacks in the CloudFormation User Guide.
stack_id
class-attribute
instance-attribute
¶
stack_id: str | None = ...
Unique identifier of the stack.
stack_name
class-attribute
instance-attribute
¶
stack_name: str | None = ...
The name associated with the stack.
stack_status
class-attribute
instance-attribute
¶
stack_status: str | None = ...
Current status of the stack.
stack_status_reason
class-attribute
instance-attribute
¶
stack_status_reason: str | None = ...
Success/failure message associated with the stack status.
tags
class-attribute
instance-attribute
¶
A list of Tags that specify information about the stack.