Class: Aws::ECS::Waiters::ServicesInactive

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ServicesInactive

Returns a new instance of ServicesInactive.

Parameters:

  • options (Hash)

Options Hash (options):

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


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 328

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_services,
      acceptors: [
        {
          "matcher" => "pathAny",
          "argument" => "failures[].reason",
          "state" => "failure",
          "expected" => "MISSING"
        },
        {
          "matcher" => "pathAny",
          "argument" => "services[].status",
          "state" => "success",
          "expected" => "INACTIVE"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

  • :services (required, Array<String>)

    A list of services to describe. You may specify up to 10 services to describe in a single operation.

  • :include (Array<String>)

    Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:



355
356
357
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 355

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