cloudformation_describe_stacks: Returns the description for the specified stack; if no stack...

View source: R/cloudformation_operations.R

cloudformation_describe_stacksR Documentation

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created

Description

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.

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

Usage

cloudformation_describe_stacks(StackName = NULL, NextToken = NULL)

Arguments

StackName

If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires list_stacks and describe_stacks permissions.

Consider using the list_stacks API if you're not passing a parameter to StackName.

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:::stack//" }] }

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.

Default: There is no default value.

NextToken

A string that identifies the next page of stacks that you want to retrieve.


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