DescribeStackResource - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeStackResource

Returns a description of the specified resource in the specified stack.

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

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.

Default: There is no default value.

Type: String

Required: Yes

StackName

The name or the unique stack ID that's 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.

Default: There is no default value.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

StackResourceDetail

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

Type: StackResourceDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

DescribeStackResource

This example illustrates one usage of DescribeStackResource.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStackResource &StackName=MyStack &LogicalResourceId=MyDBInstance &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2011-07-08T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]

Sample Response

<DescribeStackResourceResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <DescribeStackResourceResult> <StackResourceDetail> <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::RDS::DBInstance</ResourceType> <LastUpdatedTimestamp>2011-07-07T22:27:28Z</LastUpdatedTimestamp> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> </StackResourceDetail> </DescribeStackResourceResult> <ResponseMetadata> <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId> </ResponseMetadata> </DescribeStackResourceResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: