CloudFormation / Resource / Stack

Stack

Note

Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources.

class CloudFormation.Stack(name)

A resource representing an AWS CloudFormation Stack:

import boto3

cloudformation = boto3.resource('cloudformation')
stack = cloudformation.Stack('name')

Parameters:

name (string) – The Stack’s name identifier. This must be set.

Identifiers

Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.

These are the resource’s available identifiers:

• name

Attributes

Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.

These are the resource’s available attributes:

• capabilities
• change_set_id
• creation_time
• deletion_time
• description
• detailed_status
• disable_rollback
• drift_information
• enable_termination_protection
• last_updated_time
• notification_arns
• outputs
• parameters
• parent_id
• retain_except_on_create
• role_arn
• rollback_configuration
• root_id
• stack_id
• stack_name
• stack_status
• stack_status_reason
• tags
• timeout_in_minutes

Actions

Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.

These are the resource’s available actions:

• cancel_update
• delete
• get_available_subresources
• load
• reload
• update

Sub-resources

Sub-resources are methods that create a new instance of a child resource. This resource’s identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.

These are the resource’s available sub-resources:

• Resource

Collections

Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.

These are the resource’s available collections:

• events
• resource_summaries