Class: Aws::AutoScaling::LoadBalancer

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name, name, options = {}) ⇒ LoadBalancer #initialize(options = {}) ⇒ LoadBalancer

Returns a new instance of LoadBalancer.

Overloads:

  • #initialize(group_name, name, options = {}) ⇒ LoadBalancer

    Parameters:

    • group_name (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ LoadBalancer

    Options Hash (options):

    • :group_name (required, String)
    • :name (required, String)
    • :client (Client)


24
25
26
27
28
29
30
31
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 24

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @group_name = extract_group_name(args, options)
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#attach(options = {}) ⇒ Types::AttachLoadBalancersResultType

Examples:

Request syntax with placeholder values


load_balancer.attach()

Parameters:

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

    ({})

Returns:



203
204
205
206
207
208
209
210
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 203

def attach(options = {})
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    load_balancer_names: [@name]
  )
  resp = @client.attach_load_balancers(options)
  resp.data
end

#clientClient

Returns:



72
73
74
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 72

def client
  @client
end

#dataTypes::LoadBalancerState

Returns the data for this Aws::AutoScaling::LoadBalancer.

Returns:

Raises:



87
88
89
90
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 87

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



95
96
97
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 95

def data_loaded?
  !!@data
end

#detach(options = {}) ⇒ Types::DetachLoadBalancersResultType

Examples:

Request syntax with placeholder values


load_balancer.detach()

Parameters:

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

    ({})

Returns:



217
218
219
220
221
222
223
224
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 217

def detach(options = {})
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    load_balancer_names: [@name]
  )
  resp = @client.detach_load_balancers(options)
  resp.data
end

#groupAutoScalingGroup

Returns:



229
230
231
232
233
234
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 229

def group
  AutoScalingGroup.new(
    name: @group_name,
    client: @client
  )
end

#group_nameString

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 36

def group_name
  @group_name
end

#nameString Also known as: load_balancer_name

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 41

def name
  @name
end

#stateString

One of the following load balancer states:

  • Adding - The instances in the group are being registered with the load balancer.

  • Added - All instances in the group are registered with the load balancer.

  • InService - At least one instance in the group passed an ELB health check.

  • Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

  • Removed - All instances in the group are deregistered from the load balancer.

Returns:

  • (String)


65
66
67
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 65

def state
  data[:state]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::AutoScaling::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/load_balancer.rb', line 179

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end