cloudformation_describe_stack_resources: Returns Amazon Web Services resource descriptions for running...

View source: R/cloudformation_operations.R

cloudformation_describe_stack_resourcesR Documentation

Returns Amazon Web Services resource descriptions for running and deleted stacks

Description

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.

See https://www.paws-r-sdk.com/docs/cloudformation_describe_stack_resources/ for full documentation.

Usage

cloudformation_describe_stack_resources(
  StackName = NULL,
  LogicalResourceId = NULL,
  PhysicalResourceId = NULL
)

Arguments

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.

Default: There is no default value.

Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.

LogicalResourceId

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

Default: There is no default value.

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 describe_stack_resources 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.

Default: There is no default value.


paws.management documentation built on Sept. 12, 2024, 6:19 a.m.