DescribeStackResourcesRequest Class

Container for the parameters to the DescribeStackResources operation. 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.

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 CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudFormation.AmazonCloudFormationRequest
      Amazon.CloudFormation.Model.DescribeStackResourcesRequest

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

public class DescribeStackResourcesRequest : AmazonCloudFormationRequest
         IAmazonWebServiceRequest

The DescribeStackResourcesRequest type exposes the following members

Constructors

	Name	Description
	DescribeStackResourcesRequest()

Properties

Name Type Description

Name	Type	Description
LogicalResourceId	System.String	Gets and sets the property LogicalResourceId. The logical name of the resource as specified in the template.
PhysicalResourceId	System.String	Gets and sets the property 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, `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the EC2 `InstanceId` to `DescribeStackResources` to 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 specify `StackName`.
StackName	System.String	Gets and sets the property 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 specify `PhysicalResourceId`.

LogicalResourceId

System.String

Gets and sets the property LogicalResourceId.

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

PhysicalResourceId

System.String

Gets and sets the property 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, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to 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 specify StackName.

StackName

System.String

Gets and sets the property 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 specify PhysicalResourceId.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5