Class: AWS::ELB::LoadBalancer

Inherits:
Core::Resource show all
Defined in:
lib/aws/elb/load_balancer.rb

Instance Attribute Summary collapse

Attributes included from Core::Model

#config

Instance Method Summary collapse

Methods inherited from Core::Resource

attribute_providers, attribute_providers_for, attributes, #attributes_from_response, define_attribute_type, #eql?, #inspect, new_from

Methods included from Core::Cacheable

included, #retrieve_attribute

Methods included from Core::Model

#client, #config_prefix, #inspect

Constructor Details

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

Returns a new instance of LoadBalancer.



35
36
37
 
# File 'lib/aws/elb/load_balancer.rb', line 35

def initialize name, options = {}
  super(options.merge(:name => name.to_s))
end

Instance Attribute Details

#availability_zone_names ⇒ Array<String> (readonly)

Return the names of the availability zones this load balancer routes traffic to.

Returns:

  • (Array<String>) —

    the current value of availability_zone_names



33
34
35
 
# File 'lib/aws/elb/load_balancer.rb', line 33

def availability_zone_names
  @availability_zone_names
end

#canonical_hosted_zone_name ⇒ String (readonly)

Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For more information: http://docs.amazonwebservices.com/ElasticLoadBalancing/latest/DeveloperGuide/index.html?using-domain-names-with-elb.html.

Returns:

  • (String) —

    the current value of canonical_hosted_zone_name



33
34
35
 
# File 'lib/aws/elb/load_balancer.rb', line 33

def canonical_hosted_zone_name
  @canonical_hosted_zone_name
end

#canonical_hosted_zone_name_id ⇒ String (readonly)

Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For more information: http://docs.amazonwebservices.com/ElasticLoadBalancing/latest/DeveloperGuide/index.html?using-domain-names-with-elb.html.

Returns:

  • (String) —

    the current value of canonical_hosted_zone_name_id



33
34
35
 
# File 'lib/aws/elb/load_balancer.rb', line 33

def canonical_hosted_zone_name_id
  @canonical_hosted_zone_name_id
end

#dns_name ⇒ String (readonly)

Specifies the external DNS name associated with this load balancer.

Returns:

  • (String) —

    the current value of dns_name



33
34
35
 
# File 'lib/aws/elb/load_balancer.rb', line 33

def dns_name
  @dns_name
end

#name ⇒ String (readonly)

The name of the load balancer.

Returns:

  • (String) —

    the current value of name



33
34
35
 
# File 'lib/aws/elb/load_balancer.rb', line 33

def name
  @name
end

Instance Method Details

#availability_zones ⇒ AvailabilityZoneCollection

A collection that help maanage the availability zones for this load balancer.

Examples:

enable an availability zone


load_balancer.availability_zones.enable('us-east-1b')

disable an availability zone


load_balancer.availability_zones.disable('us-east-1b')

list enabled availability zoens


load_balancer.availability_zones.each do |zone|
  puts zone.name
end

Returns:

  • (AvailabilityZoneCollection) —

    Returns a collection that represents this load balancer’s availability zones. You can use this collection to enable and disable availability zones.



95
96
97
 
# File 'lib/aws/elb/load_balancer.rb', line 95

def availability_zones
  AvailabilityZoneCollection.new(self)
end

#backend_server_policies ⇒ BackendServerPolicyCollection

Returns:



115
116
117
 
# File 'lib/aws/elb/load_balancer.rb', line 115

def backend_server_policies
  BackendServerPolicyCollection.new(self)
end

#configure_health_check(options = {}) ⇒ Object

Updates the configuration that drives the instance health checks.

You only need to pass the options you want to change. You can call #health_check_configuration if you want to see what the current configuration values are.

Parameters:

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

Options Hash (options):

  • :healthy_threshold (Integer) —

    Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

  • :unhealthy_threshold (Integer) —

    Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

  • :interval (Integer) —

    Specifies the approximate interval, in seconds, between health checks of an individual instance.

  • :timeout (Integer) —

    Specifies the amount of time, in seconds, during which no response means a failed health probe.

    This value must be less than the :interval value.

  • :target (String) —

    Specifies the instance being checked.

    This option should be formatted like: “TCP:80”

    • The protocol is either TCP, HTTP, HTTPS, or SSL.

    • The range of valid ports is one (1) through 65535.

    TCP is the default, specified as a TCP: port pair, for example “TCP:5000”. In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

    SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example “HTTP:80/weather/us/wa/seattle”. In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than “200 OK” within the timeout period is considered unhealthy.

    The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/aws/elb/load_balancer.rb', line 167

def configure_health_check options = {}

  new_config = health_check_configuration.merge(options)

  response = client.configure_health_check(
    :load_balancer_name => name,
    :health_check => new_config)

  new_config

end

#delete ⇒ nil

Deletes the load balancer.

Returns:

  • (nil) 


235
236
237
238
 
# File 'lib/aws/elb/load_balancer.rb', line 235

def delete
  client.delete_load_balancer(:load_balancer_name => name)
  nil
end

#exists? ⇒ Boolean

Returns true if the load balancer exists.

Returns:

  • (Boolean) —

    Returns true if the load balancer exists.



226
227
228
229
230
231
 
# File 'lib/aws/elb/load_balancer.rb', line 226

def exists?
  client.describe_load_balancers(:load_balancer_names => [name])
  true
rescue Errors::LoadBalancerNotFound
  false
end

#health_check_configuration ⇒ Hash

Returns a hash of the various health probes conducted on the load balancer instances. The following entries are returned:

* +:healthy_threshold+
* +:unhealthy_threshold+
* +:interval+
* +:target+
* +:timeout+

See #configure_health_check for more details on what each of the configuration values mean.

Returns:

  • (Hash) 


193
194
195
196
197
198
199
200
201
202
 
# File 'lib/aws/elb/load_balancer.rb', line 193

def health_check_configuration
  cfg = health_check_description
  {
    :healthy_threshold => cfg.healthy_threshold,
    :unhealthy_threshold => cfg.unhealthy_threshold,
    :interval => cfg.interval,
    :target => cfg.target,
    :timeout => cfg.timeout,
  }
end

#instances ⇒ InstanceCollection

Returns:



110
111
112
 
# File 'lib/aws/elb/load_balancer.rb', line 110

def instances
  InstanceCollection.new(self)
end

#listeners ⇒ ListenerCollection

Returns:



100
101
102
 
# File 'lib/aws/elb/load_balancer.rb', line 100

def listeners
  ListenerCollection.new(self)
end

#policies ⇒ PolicyCollection

Returns:

  • (PolicyCollection) 


105
106
107
 
# File 'lib/aws/elb/load_balancer.rb', line 105

def policies
  LoadBalancerPolicyCollection.new(self)
end

#source_security_group ⇒ Hash

Generally you don’t need to call this method, rather you can just pass the load balancer as a source to the various authorize and revoke methods of AWS::EC2::SecurityGroup:

security_group.authorize_ingress(load_balancer)

security_group.revoke_ingress(load_balancer)

Returns:



218
219
220
221
222
223
 
# File 'lib/aws/elb/load_balancer.rb', line 218

def source_security_group
  { 
    :group_name => security_group_description.group_name,
    :user_id => security_group_description.owner_alias,
  }
end