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

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

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

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)


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/waiters.rb', line 21

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 Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :name (required, String)

    The name of the cluster to describe.

Returns:



54
55
56
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/waiters.rb', line 54

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