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

Class: Aws::OpsWorks::Waiters::InstanceRegistered

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

Overview

Wait until OpsWorks instance is registered.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ InstanceRegistered

Returns a new instance of InstanceRegistered

Parameters:

  • options (Hash)

Options Hash (options):

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


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 196

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_instances,
      acceptors: [
        {
          "expected" => "registered",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "instances[].status"
        },
        {
          "expected" => "setup_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "shutting_down",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stopped",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stopping",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "terminating",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "terminated",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stop_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :stack_id (String)

    A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

  • :layer_id (String)

    A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

  • :instance_ids (Array<String>)

    An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:



259
260
261
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 259

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