Class: Aws::CloudFormation::Types::DescribeStacksInput

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::DescribeStacksInput

show all

Defined in:: gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

The input for DescribeStacks action.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#next_token ⇒ String
A string that identifies the next page of stacks that you want to retrieve.
#stack_name ⇒ String
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.

Instance Attribute Details

#next_token ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3386

class DescribeStacksInput < Struct.new(
  :stack_name,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ `String`

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 ListStacks and DescribeStacks 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.