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

Class: Aws::ElasticLoadBalancing::Waiters::InstanceInService

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ InstanceInService

Returns a new instance of InstanceInService

Parameters:

  • options (Hash)

Options Hash (options):

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


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/waiters.rb', line 100

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_instance_health,
      acceptors: [
        {
          "argument" => "instance_states[].state",
          "expected" => "InService",
          "matcher" => "pathAll",
          "state" => "success"
        },
        {
          "matcher" => "error",
          "expected" => "InvalidInstance",
          "state" => "retry"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

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_name (required, String)

    The name of the load balancer.

  • :instances (Array<Types::Instance>)

    The IDs of the instances.

Returns:



126
127
128
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/waiters.rb', line 126

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