Skip to content

CloudFormation  >  Operations  >  describe_stack_resource

describe_stack_resource

Operation

describe_stack_resource async

describe_stack_resource(input: DescribeStackResourceInput, plugins: list[Plugin] | None = None) -> DescribeStackResourceOutput

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.

Parameters:

Name Type Description Default
input DescribeStackResourceInput

An instance of DescribeStackResourceInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeStackResourceOutput

An instance of DescribeStackResourceOutput.

Input

DescribeStackResourceInput dataclass

Bases: _SerdeShape

The input for DescribeStackResource action.

Attributes

logical_resource_id class-attribute instance-attribute
logical_resource_id: str | None = ...

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

stack_name class-attribute instance-attribute
stack_name: str | None = ...

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.

Output

DescribeStackResourceOutput dataclass

Bases: _SerdeShape

The output for a DescribeStackResource action.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stack_resource_detail class-attribute instance-attribute
stack_resource_detail: StackResourceDetail | None = ...

A StackResourceDetail structure that contains the description of the specified resource in the specified stack.