[ aws . cloudformation ]
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-stack-resource
--stack-name <value>
--logical-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.
--logical-resource-id
(string)
The logical name of the resource as specified in the template.
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-resource
example displays details for the resource named MyFunction
in the specified stack.
aws cloudformation describe-stack-resource \
--stack-name MyStack \
--logical-resource-id MyFunction
Output:
{
"StackResourceDetail": {
"StackName": "MyStack",
"StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
"LogicalResourceId": "MyFunction",
"PhysicalResourceId": "my-function-SEZV4XMPL4S5",
"ResourceType": "AWS::Lambda::Function",
"LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
"ResourceStatus": "UPDATE_COMPLETE",
"Metadata": "{}",
"DriftInformation": {
"StackResourceDriftStatus": "IN_SYNC"
}
}
}
StackResourceDetail -> (structure)
A
StackResourceDetail
structure containing the description of the specified resource in the specified stack.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.)
LastUpdatedTimestamp -> (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.
Metadata -> (string)
The content of the
Metadata
attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.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 .