CloudFormation / Waiter / StackExists

StackExists#

class CloudFormation.Waiter.StackExists#

waiter = client.get_waiter('stack_exists')

wait(**kwargs)#

Polls CloudFormation.Client.describe_stacks() every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.

waiter.wait(
    StackName='string',
    NextToken='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

StackName (string) –

Note
If you don’t pass a parameter to StackName, the API returns a response that describes all resources in the account. This requires ListStacks and DescribeStacks permissions.

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 (string) – A string that identifies the next page of stacks that you want to retrieve.
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) –
  
  The maximum number of attempts to be made. Default: 20

Returns:

None