Class: Aws::CloudFormation::Waiters::StackRefactorExecuteComplete

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-cloudformation/waiters.rb

Overview

Wait until the stack refactor status is EXECUTE_COMPLETE.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StackRefactorExecuteComplete

Returns a new instance of StackRefactorExecuteComplete.

Parameters:

  • options (Hash)

Options Hash (options):

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


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 518

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_stack_refactor,
      acceptors: [
        {
          "argument" => "execution_status",
          "expected" => "EXECUTE_COMPLETE",
          "matcher" => "path",
          "state" => "success"
        },
        {
          "argument" => "execution_status",
          "expected" => "EXECUTE_FAILED",
          "matcher" => "path",
          "state" => "failure"
        },
        {
          "argument" => "execution_status",
          "expected" => "ROLLBACK_COMPLETE",
          "matcher" => "path",
          "state" => "failure"
        },
        {
          "expected" => "ValidationError",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (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.



561
562
563
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 561

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :stack_refactor_id (required, String)

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

Returns:



556
557
558
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 556

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