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

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

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

Overview

Wait until OpsWorks instance is stopped.

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)


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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 277

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" => "online",
          "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 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:



352
353
354
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 352

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