/AWS1/CL_FRM=>DESCRIBESTACKS()
¶
About DescribeStacks¶
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.
If the stack doesn't exist, a ValidationError
is returned.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_STACKNAME
TYPE /AWS1/FRMSTACKNAME
/AWS1/FRMSTACKNAME
¶
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 requiresListStacks
andDescribeStacks
permissions.Consider using the ListStacks 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.
IV_NEXTTOKEN
TYPE /AWS1/FRMNEXTTOKEN
/AWS1/FRMNEXTTOKEN
¶
A string that identifies the next page of stacks that you want to retrieve.