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

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

Instance Attribute Summary collapse

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)

87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/aws-sdk-ecs/waiters.rb', line 87

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

Instance Attribute Details

#waiterObject (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.


119
120
121
# File 'lib/aws-sdk-ecs/waiters.rb', line 119

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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>)

    Specifies 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 are not included in the response.

Returns:


114
115
116
# File 'lib/aws-sdk-ecs/waiters.rb', line 114

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