Class: Aws::EKS::Waiters::ClusterActive

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ClusterActive

Returns a new instance of ClusterActive.

Parameters:

  • options (Hash)

Options Hash (options):

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

184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/aws-sdk-eks/waiters.rb', line 184

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_cluster,
      acceptors: [
        {
          "expected" => "DELETING",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "cluster.status"
        },
        {
          "expected" => "FAILED",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "cluster.status"
        },
        {
          "expected" => "ACTIVE",
          "matcher" => "path",
          "state" => "success",
          "argument" => "cluster.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.


222
223
224
# File 'lib/aws-sdk-eks/waiters.rb', line 222

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :name (required, String)

    The name of the cluster to describe.

Returns:


217
218
219
# File 'lib/aws-sdk-eks/waiters.rb', line 217

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