Class: Aws::CloudFormation::Waiters::StackCreateComplete

Inherits:

Object

• Object
• Aws::CloudFormation::Waiters::StackCreateComplete

Defined in:

lib/aws-sdk-cloudformation/waiters.rb

Overview

Wait until stack status is CREATE_COMPLETE.

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ StackCreateComplete constructor

  A new instance of StackCreateComplete.

• #wait(params = {}) ⇒ Types::DescribeStacksOutput

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ StackCreateComplete

Returns a new instance of StackCreateComplete.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 120
• :delay (Integer) — default: 30
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'lib/aws-sdk-cloudformation/waiters.rb', line 142

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_stacks,
      acceptors: [
        {
          "argument" => "stacks[].stack_status",
          "expected" => "CREATE_COMPLETE",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_COMPLETE",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_IN_PROGRESS",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_FAILED",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_ROLLBACK_IN_PROGRESS",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_ROLLBACK_FAILED",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "UPDATE_ROLLBACK_COMPLETE",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "CREATE_FAILED",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "DELETE_COMPLETE",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "DELETE_FAILED",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "ROLLBACK_FAILED",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "argument" => "stacks[].stack_status",
          "expected" => "ROLLBACK_COMPLETE",
          "matcher" => "pathAny",
          "state" => "failure"
        },
        {
          "expected" => "ValidationError",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-cloudformation/waiters.rb', line 251

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeStacksOutput

Returns a response object which responds to the following methods:

• #stacks => Array<Types::Stack>

• #next_token => String

Options Hash (params):

• :stack_name (String) —

  <note markdown=“1”> 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//” \}] \}

  </note>
  

  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.

• :next_token (String) —

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

Returns:

• (Types::DescribeStacksOutput) —

  Returns a response object which responds to the following methods:

  • #stacks => Array&lt;Types::Stack&gt;

  • #next_token => String

# File 'lib/aws-sdk-cloudformation/waiters.rb', line 246

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end