[ aws . cloudformation ]
Returns Amazon Web Services 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
, go to the CloudFormation User Guide .
Note
A ValidationError
is returned if you specify both StackName
and PhysicalResourceId
in the same request.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-stack-resources
[--stack-name <value>]
[--logical-resource-id <value>]
[--physical-resource-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--stack-name
(string)
The name or the unique stack ID that is associated with the stack, which are not 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.
Required: Conditional. If you do not specify
StackName
, you must specifyPhysicalResourceId
.
--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 CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId
corresponds to theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
to find which stack the instance belongs to and what other resources are part of the stack.Required: Conditional. If you do not specify
PhysicalResourceId
, you must specifyStackName
.Default: There is no default value.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get information about a stack resource
The following describe-stack-resources
example displays details for the resources in the specified stack.
aws cloudformation describe-stack-resources \
--stack-name my-stack
Output:
{
"StackResources": [
{
"StackName": "my-stack",
"StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
"LogicalResourceId": "bucket",
"PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
"ResourceType": "AWS::S3::Bucket",
"Timestamp": "2019-10-02T04:34:11.345Z",
"ResourceStatus": "CREATE_COMPLETE",
"DriftInformation": {
"StackResourceDriftStatus": "IN_SYNC"
}
},
{
"StackName": "my-stack",
"StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
"LogicalResourceId": "function",
"PhysicalResourceId": "my-function-SEZV4XMPL4S5",
"ResourceType": "AWS::Lambda::Function",
"Timestamp": "2019-10-02T05:34:27.989Z",
"ResourceStatus": "UPDATE_COMPLETE",
"DriftInformation": {
"StackResourceDriftStatus": "IN_SYNC"
}
},
{
"StackName": "my-stack",
"StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
"LogicalResourceId": "functionRole",
"PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
"ResourceType": "AWS::IAM::Role",
"Timestamp": "2019-10-02T04:34:06.350Z",
"ResourceStatus": "CREATE_COMPLETE",
"DriftInformation": {
"StackResourceDriftStatus": "IN_SYNC"
}
}
]
}
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 CloudFormation.
ResourceType -> (string)
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the 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.
DriftInformation -> (structure)
Information about whether the resource’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 .
StackResourceDriftStatus -> (string)
Status of the resource’s actual configuration compared to its expected configuration
DELETED
: The resource differs from its expected configuration in that it has been deleted.
MODIFIED
: The resource differs from its expected configuration.
NOT_CHECKED
: CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status ofNOT_CHECKED
. For more information, see Resources that Support Drift Detection .
IN_SYNC
: The resources’s actual configuration matches its expected configuration.LastCheckTimestamp -> (timestamp)
When CloudFormation last checked if the resource had drifted from its expected configuration.
ModuleInfo -> (structure)
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy -> (string)
A concantenated list of the the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by
/
.In the following example, the resource was created from a module of type
AWS::First::Example::MODULE
, that is nested inside a parent module of typeAWS::Second::Example::MODULE
.
AWS::First::Example::MODULE/AWS::Second::Example::MODULE
LogicalIdHierarchy -> (string)
A concantenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by
/
.In the following example, the resource was created from a module,
moduleA
, that is nested inside a parent module,moduleB
.
moduleA/moduleB
For more information, see Referencing resources in a module in the CloudFormation User Guide .