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

Class: Aws::ElasticLoadBalancingV2::Waiters::LoadBalancerAvailable

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ LoadBalancerAvailable

Returns a new instance of LoadBalancerAvailable

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 40
  • :delay (Integer) — default: 15
  • :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
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/waiters.rb', line 21

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_load_balancers,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "load_balancers[].state.code",
          "expected" => "active"
        },
        {
          "state" => "retry",
          "matcher" => "pathAny",
          "argument" => "load_balancers[].state.code",
          "expected" => "provisioning"
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "LoadBalancerNotFound"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :load_balancer_arns (Array<String>)

    The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

  • :names (Array<String>)

    The names of the load balancers.

  • :marker (String)

    The marker for the next set of results. (You received this marker from a previous call.)

  • :page_size (Integer)

    The maximum number of results to return with this call.

Returns:



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

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