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

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

Overview

Wait until change set status is CREATE_COMPLETE.

Instance Attribute Summary collapse

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)

92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 92

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 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.


129
130
131
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 129

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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:


124
125
126
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 124

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