AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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)


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 264

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:



327
328
329
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 327

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