Returns AWS resource descriptions for running and deleted stacks. If
StackName is specified, all the associated resources that are part of the stack
are returned. If PhysicalResourceId 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 ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for
up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not
both. In addition, you can specify LogicalResourceId to filter the returned
result. For more information about resources, the LogicalResourceId and
PhysicalResourceId, see the AWS CloudFormation User Guide.
Note
A ValidationError is returned if you specify both StackName
and PhysicalResourceId in the same request.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- LogicalResourceId
-
The logical name of the resource as specified in the template.
Type: String
Required: No
- PhysicalResourceId
-
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceIdcorresponds to theInstanceId. You can pass the EC2InstanceIdtoDescribeStackResourcesto find which stack the instance belongs to and what other resources are part of the stack.Required: Conditional. If you don't specify
PhysicalResourceId, you must specifyStackName.Type: String
Required: No
- StackName
-
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
-
Running stacks: You can specify either the stack's name or its unique stack ID.
-
Deleted stacks: You must specify the unique stack ID.
Required: Conditional. If you don't specify
StackName, you must specifyPhysicalResourceId.Type: String
Required: No
-
Response Elements
The following element is returned by the service.
- StackResources.member.N
-
A list of
StackResourcestructures.Type: Array of StackResource objects
Errors
For information about the errors that are common to all actions, see Common Errors.
Examples
DescribeStackResources
This example illustrates one usage of DescribeStackResources.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeStackResources
&StackName=MyStack
&Version=2010-05-15
&SignatureVersion=2
&Timestamp=2010-07-27T22%3A26%3A28.000Z
&AWSAccessKeyId=[AWS Access KeyID]
&Signature=[Signature]Sample Response
<DescribeStackResourcesResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeStackResourcesResult>
<StackResources>
<member>
<StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
<StackName>MyStack</StackName>
<LogicalResourceId>MyDBInstance</LogicalResourceId>
<PhysicalResourceId>MyStack_DB1</PhysicalResourceId>
<ResourceType>AWS::DBInstance</ResourceType>
<Timestamp>2010-07-27T22:27:28Z</Timestamp>
<ResourceStatus>CREATE_COMPLETE</ResourceStatus>
</member>
<member>
<StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
<StackName>MyStack</StackName>
<LogicalResourceId>MyAutoScalingGroup</LogicalResourceId>
<PhysicalResourceId>MyStack_ASG1</PhysicalResourceId>
<ResourceType>AWS::AutoScalingGroup</ResourceType>
<Timestamp>2010-07-27T22:28:28Z</Timestamp>
<ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
</member>
</StackResources>
</DescribeStackResourcesResult>
<ResponseMetadata>
<RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
</ResponseMetadata>
</DescribeStackResourcesResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
