You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Waiters::ChangeSetCreateComplete

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

Overview

Wait until change set status is CREATE_COMPLETE.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChangeSetCreateComplete

Returns a new instance of ChangeSetCreateComplete

Parameters:

  • options (Hash)

Options Hash (options):

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


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/waiters.rb', line 22

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_change_set,
      acceptors: [
        {
          "argument" => "status",
          "expected" => "CREATE_COMPLETE",
          "matcher" => "path",
          "state" => "success"
        },
        {
          "argument" => "status",
          "expected" => "FAILED",
          "matcher" => "path",
          "state" => "failure"
        },
        {
          "expected" => "ValidationError",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :change_set_name (required, String)

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

  • :stack_name (String)

    If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

  • :next_token (String)

    A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

Returns:



54
55
56
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/waiters.rb', line 54

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