Class: Aws::AutoScaling::LoadBalancer
- Inherits:
-
Object
- Object
- Aws::AutoScaling::LoadBalancer
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-autoscaling/load_balancer.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #group_name ⇒ String
- #name ⇒ String (also: #load_balancer_name)
-
#state ⇒ String
One of the following load balancer states:.
Actions collapse
- #attach(options = {}) ⇒ Types::AttachLoadBalancersResultType
- #detach(options = {}) ⇒ Types::DetachLoadBalancersResultType
Associations collapse
- #group ⇒ AutoScalingGroup
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::LoadBalancerState
Returns the data for this LoadBalancer.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ LoadBalancer
constructor
A new instance of LoadBalancer.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::AutoScaling::Client] #wait_until instead
Constructor Details
#initialize(group_name, name, options = {}) ⇒ LoadBalancer #initialize(options = {}) ⇒ LoadBalancer
Returns a new instance of LoadBalancer.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @group_name = extract_group_name(args, ) @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#attach(options = {}) ⇒ Types::AttachLoadBalancersResultType
197 198 199 200 201 202 203 204 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 197 def attach( = {}) = Aws::Util.deep_merge(, auto_scaling_group_name: @group_name, load_balancer_names: [@name] ) resp = @client.attach_load_balancers() resp.data end |
#client ⇒ Client
68 69 70 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 68 def client @client end |
#data ⇒ Types::LoadBalancerState
Returns the data for this Aws::AutoScaling::LoadBalancer.
83 84 85 86 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 83 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
91 92 93 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 91 def data_loaded? !!@data end |
#detach(options = {}) ⇒ Types::DetachLoadBalancersResultType
211 212 213 214 215 216 217 218 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 211 def detach( = {}) = Aws::Util.deep_merge(, auto_scaling_group_name: @group_name, load_balancer_names: [@name] ) resp = @client.detach_load_balancers() resp.data end |
#group ⇒ AutoScalingGroup
223 224 225 226 227 228 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 223 def group AutoScalingGroup.new( name: @group_name, client: @client ) end |
#group_name ⇒ String
32 33 34 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 32 def group_name @group_name end |
#identifiers ⇒ Object
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.
232 233 234 235 236 237 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 232 def identifiers { group_name: @group_name, name: @name } end |
#load ⇒ Object Also known as: reload
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.
74 75 76 77 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 74 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#name ⇒ String Also known as: load_balancer_name
37 38 39 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 37 def name @name end |
#state ⇒ String
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.
61 62 63 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 61 def state data[:state] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::AutoScaling::Client] #wait_until instead
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() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
## 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
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/aws-sdk-autoscaling/load_balancer.rb', line 173 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |