Class: Aws::CloudFormation::Waiters::StackRefactorCreateComplete

Inherits:

Object

• Object
• Aws::CloudFormation::Waiters::StackRefactorCreateComplete

Defined in:

lib/aws-sdk-cloudformation/waiters.rb

Overview

Wait until the stack refactor status is CREATE_COMPLETE.

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ StackRefactorCreateComplete constructor

  A new instance of StackRefactorCreateComplete.

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

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

Constructor Details

#initialize(options) ⇒ StackRefactorCreateComplete

Returns a new instance of StackRefactorCreateComplete.

Parameters:

• options (Hash)

Options Hash (options):

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

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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_stack_refactor,
      acceptors: [
        {
          "argument" => "status",
          "expected" => "CREATE_COMPLETE",
          "matcher" => "path",
          "state" => "success"
        },
        {
          "argument" => "status",
          "expected" => "CREATE_FAILED",
          "matcher" => "path",
          "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 505

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #description => String

• #stack_refactor_id => String

• #stack_ids => Array<String>

• #execution_status => String

• #execution_status_reason => String

• #status => String

• #status_reason => String

Options Hash (params):

• :stack_refactor_id (required, String) —

  The ID associated with the stack refactor created from the CreateStackRefactor action.

Returns:

• (Types::DescribeStackRefactorOutput) —

  Returns a response object which responds to the following methods:

  • #description => String

  • #stack_refactor_id => String

  • #stack_ids => Array<String>

  • #execution_status => String

  • #execution_status_reason => String

  • #status => String

  • #status_reason => String

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

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