Class: Aws::OpsWorks::Waiters::InstanceStopped

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

Overview

Wait until OpsWorks instance is stopped.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ InstanceStopped

Returns a new instance of InstanceStopped.

Parameters:

  • options (Hash)

Options Hash (options):

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


345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 345

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" => "stopped",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "instances[].status"
        },
        {
          "expected" => "booting",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "pending",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "rebooting",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "requested",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "running_setup",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "setup_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "start_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stop_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (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. 



419
420
421
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 419

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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:



414
415
416
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 414

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