AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Table Of Contents

Feedback

[ aws . cloudformation ]

describe-stack-resources

Description

Returns AWS resource descriptions for running and deleted stacks. If --stack-name is specified, all the associated resources that are part of the stack are returned. If --physical-resource-id is specified, the associated resources of the stack that the resource belongs to are returned.

Note

Only the first 100 resources will be returned. If your stack has more resources than this, you should use list-stack-resources instead.

For deleted stacks, describe-stack-resources returns resource information for up to 90 days after the stack has been deleted.

You must specify either --stack-name or --physical-resource-id , but not both. In addition, you can specify --logical-resource-id to filter the returned result. For more information about resources, the --logical-resource-id and --physical-resource-id , go to the AWS CloudFormation User Guide .

Note

A ValidationError is returned if you specify both --stack-name and --physical-resource-id in the same request.

Synopsis

  describe-stack-resources
[--stack-name <value>]
[--logical-resource-id <value>]
[--physical-resource-id <value>]

Options

--stack-name (string)

The name or the unique identifier associated with the stack.

Required: Conditional. If you do not specify --stack-name , you must specify --physical-resource-id .

Default: There is no default value.

--logical-resource-id (string)

The logical name of the resource as specified in the template.

Default: There is no default value.

--physical-resource-id (string)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, --physical-resource-id corresponds to the InstanceId . You can pass the EC2 InstanceId to describe-stack-resources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify --physical-resource-id , you must specify --stack-name .

Default: There is no default value.

Output

StackResources -> (list)

A list of StackResource structures.

(structure)

The StackResource data type.

StackName -> (string)

The name associated with the stack.

StackId -> (string)

Unique identifier of the stack.

LogicalResourceId -> (string)

The logical name of the resource specified in the template.

PhysicalResourceId -> (string)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

ResourceType -> (string)

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Timestamp -> (timestamp)

Time the status was updated.

ResourceStatus -> (string)

Current status of the resource.

ResourceStatusReason -> (string)

Success/failure message associated with the resource.

Description -> (string)

User defined description associated with the resource.