Skip to content

aws.cloudformation.describe_stacks

Example SQL Queries

SELECT * FROM
aws.cloudformation.describe_stacks;

Description

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.

If the stack doesn't exist, a ValidationError is returned.

Table Definition

Column NameColumn Data Type
stack_name Input Column

The name associated with the stack.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
capabilities

The capabilities allowed in the stack.

VARCHAR[]
Show child fields
capabilities[]
change_set_id

The unique ID of the change set.

VARCHAR
creation_time

The time at which the stack was created.

TIMESTAMP_S
deletion_mode

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 a DELETE_FAILED state due to resource deletion failure.

VARCHAR
deletion_time

The time the stack was deleted.

TIMESTAMP_S
description

A user-defined description associated with the stack.

VARCHAR
detailed_status

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 stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

VARCHAR
disable_rollback

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.

  • false: enable rollback.

BOOLEAN
drift_information

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 Detecting Unregulated Configuration Changes to Stacks and Resources.

STRUCT(
"stack_drift_status" VARCHAR,
"last_check_timestamp" TIMESTAMP_S
)
Show child fields
drift_information.last_check_timestamp

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

drift_information.stack_drift_status

Status of the stack's actual configuration compared to its expected template configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

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

  • UNKNOWN: This value is reserved for future use.

enable_termination_protection

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 Protecting a Stack From Being Deleted in the CloudFormation User Guide.

BOOLEAN
last_updated_time

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

TIMESTAMP_S
notification_ar_ns

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

VARCHAR[]
Show child fields
notification_ar_ns[]
outputs

A list of output structures.

STRUCT(
"output_key" VARCHAR,
"output_value" VARCHAR,
"description" VARCHAR,
"export_name" VARCHAR
)[]
Show child fields
outputs[]
Show child fields
outputs[].description

User defined description associated with the output.

outputs[].export_name

The name of the export associated with the output.

outputs[].output_key

The key associated with the output.

outputs[].output_value

The value associated with the output.

parameters

A list of Parameter structures.

STRUCT(
"parameter_key" VARCHAR,
"parameter_value" VARCHAR,
"use_previous_value" BOOLEAN,
"resolved_value" VARCHAR
)[]
Show child fields
parameters[]
Show child fields
parameters[].parameter_key

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

parameters[].parameter_value

The input value associated with the parameter.

parameters[].resolved_value

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.

parameters[].use_previous_value

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

parent_id

For nested stacks--stacks created as resources for another stack--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 Working with Nested Stacks in the CloudFormation User Guide.

VARCHAR
retain_except_on_create

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

BOOLEAN
role_arn

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

VARCHAR
rollback_configuration

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

STRUCT(
"rollback_triggers" STRUCT(
"arn" VARCHAR,
"type" VARCHAR
)[],
"monitoring_time_in_minutes" BIGINT
)
Show child fields
rollback_configuration.monitoring_time_in_minutes

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

rollback_configuration.rollback_triggers[]
Show child fields
rollback_configuration.rollback_triggers[].arn

The Amazon Resource Name (ARN) of the rollback trigger.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

rollback_configuration.rollback_triggers[].type

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

root_id

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

VARCHAR
stack_id

Unique identifier of the stack.

VARCHAR
stack_status

Current status of the stack.

VARCHAR
stack_status_reason

Success/failure message associated with the stack status.

VARCHAR
tags

A list of Tags that specify information about the stack.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

tags[].value

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

timeout_in_minutes

The amount of time within which stack creation should complete.

BIGINT