Class: Fog::AWS::ELB::Real
- Inherits:
-
Object
- Object
- Fog::AWS::ELB::Real
- Includes:
- CredentialFetcher::ConnectionMethods
- Defined in:
- lib/fog/aws/elb.rb,
lib/fog/aws/requests/elb/create_load_balancer.rb,
lib/fog/aws/requests/elb/delete_load_balancer.rb,
lib/fog/aws/requests/elb/configure_health_check.rb,
lib/fog/aws/requests/elb/describe_load_balancers.rb,
lib/fog/aws/requests/elb/describe_instance_health.rb,
lib/fog/aws/requests/elb/create_load_balancer_policy.rb,
lib/fog/aws/requests/elb/delete_load_balancer_policy.rb,
lib/fog/aws/requests/elb/create_load_balancer_listeners.rb,
lib/fog/aws/requests/elb/delete_load_balancer_listeners.rb,
lib/fog/aws/requests/elb/attach_load_balancer_to_subnets.rb,
lib/fog/aws/requests/elb/describe_load_balancer_policies.rb,
lib/fog/aws/requests/elb/detach_load_balancer_from_subnets.rb,
lib/fog/aws/requests/elb/create_lb_cookie_stickiness_policy.rb,
lib/fog/aws/requests/elb/create_app_cookie_stickiness_policy.rb,
lib/fog/aws/requests/elb/describe_load_balancer_policy_types.rb,
lib/fog/aws/requests/elb/register_instances_with_load_balancer.rb,
lib/fog/aws/requests/elb/apply_security_groups_to_load_balancer.rb,
lib/fog/aws/requests/elb/set_load_balancer_policies_of_listener.rb,
lib/fog/aws/requests/elb/deregister_instances_from_load_balancer.rb,
lib/fog/aws/requests/elb/set_load_balancer_listener_ssl_certificate.rb,
lib/fog/aws/requests/elb/enable_availability_zones_for_load_balancer.rb,
lib/fog/aws/requests/elb/disable_availability_zones_for_load_balancer.rb
Instance Method Summary collapse
-
#apply_security_groups_to_load_balancer(security_group_ids, lb_name) ⇒ Object
(also: #apply_security_groups)
Sets the security groups for an ELB in VPC.
-
#attach_load_balancer_to_subnets(subnet_ids, lb_name) ⇒ Object
(also: #enable_subnets)
Enable a subnet for an existing ELB.
-
#configure_health_check(lb_name, health_check) ⇒ Object
Enables the client to define an application healthcheck for the instances.
-
#create_app_cookie_stickiness_policy(lb_name, policy_name, cookie_name) ⇒ Object
Create an app cookie stickiness policy.
-
#create_lb_cookie_stickiness_policy(lb_name, policy_name, cookie_expiration_period = nil) ⇒ Object
Create a Load Balancer Cookie Stickiness Policy.
-
#create_load_balancer(availability_zones, lb_name, listeners, options = {}) ⇒ Object
Create a new Elastic Load Balancer.
-
#create_load_balancer_listeners(lb_name, listeners) ⇒ Object
Create Elastic Load Balancer Listeners.
-
#create_load_balancer_policy(lb_name, name, type_name, attributes = {}) ⇒ Object
Create Elastic Load Balancer Policy.
-
#delete_load_balancer(lb_name) ⇒ Object
Delete an existing Elastic Load Balancer.
-
#delete_load_balancer_listeners(lb_name, load_balancer_ports) ⇒ Object
Delet Elastic Load Balancer Listeners.
-
#delete_load_balancer_policy(lb_name, policy_name) ⇒ Object
Delete a Load Balancer Stickiness Policy.
-
#deregister_instances_from_load_balancer(instance_ids, lb_name) ⇒ Object
(also: #deregister_instances)
Deregister an instance from an existing ELB.
-
#describe_instance_health(lb_name, instance_ids = []) ⇒ Object
Get health status for one or more instances on an existing ELB.
-
#describe_load_balancer_policies(lb_name = nil, names = []) ⇒ Object
Describe all or specified load balancer policies.
-
#describe_load_balancer_policy_types(type_names = []) ⇒ Object
Describe all or specified load balancer policy types.
-
#describe_load_balancers(options = {}) ⇒ Object
Describe all or specified load balancers.
-
#detach_load_balancer_from_subnets(subnet_ids, lb_name) ⇒ Object
(also: #disable_subnets)
Disable a subnet for an existing ELB.
-
#disable_availability_zones_for_load_balancer(availability_zones, lb_name) ⇒ Object
(also: #disable_zones)
Disable an availability zone for an existing ELB.
-
#enable_availability_zones_for_load_balancer(availability_zones, lb_name) ⇒ Object
(also: #enable_zones)
Enable an availability zone for an existing ELB.
-
#initialize(options = {}) ⇒ Real
constructor
Initialize connection to ELB.
-
#register_instances_with_load_balancer(instance_ids, lb_name) ⇒ Object
(also: #register_instances)
Register an instance with an existing ELB.
- #reload ⇒ Object
-
#set_load_balancer_listener_ssl_certificate(lb_name, load_balancer_port, ssl_certificate_id) ⇒ Object
Sets the certificate that terminates the specified listener’s SSL connections.
-
#set_load_balancer_policies_of_listener(lb_name, load_balancer_port, policy_names) ⇒ Object
-
policy_names<~Array> - List of policies to be associated with the listener.
-
Methods included from CredentialFetcher::ConnectionMethods
#refresh_credentials_if_expired
Constructor Details
#initialize(options = {}) ⇒ Real
Initialize connection to ELB
Notes
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
Examples
elb = ELB.new(
:aws_access_key_id => your_aws_access_key_id,
:aws_secret_access_key => your_aws_secret_access_key
)
Parameters
-
options<~Hash> - config arguments for connection. Defaults to {}.
-
region<~String> - optional region to use. For instance, ‘eu-west-1’, ‘us-east-1’, etc.
-
Returns
-
ELB object with connection to AWS.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/fog/aws/elb.rb', line 122 def initialize(={}) require 'fog/core/parser' @use_iam_profile = [:use_iam_profile] setup_credentials() @connection_options = [:connection_options] || {} @instrumentor = [:instrumentor] @instrumentor_name = [:instrumentor_name] || 'fog.aws.elb' [:region] ||= 'us-east-1' @host = [:host] || "elasticloadbalancing.#{[:region]}.amazonaws.com" @path = [:path] || '/' @persistent = [:persistent] || false @port = [:port] || 443 @scheme = [:scheme] || 'https' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options) end |
Instance Method Details
#apply_security_groups_to_load_balancer(security_group_ids, lb_name) ⇒ Object Also known as: apply_security_groups
Sets the security groups for an ELB in VPC
Parameters
-
security_group_ids<~Array> - List of security group ids to enable on ELB
-
lb_name<~String> - Load balancer to disable availability zones on
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘ApplySecurityGroupsToLoadBalancer’<~Hash>:
-
‘SecurityGroups’<~Array> - array of strings describing the security group ids currently enabled
-
-
-
21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/apply_security_groups_to_load_balancer.rb', line 21 def apply_security_groups_to_load_balancer(security_group_ids, lb_name) params = Fog::AWS.indexed_param('SecurityGroups.member', [*security_group_ids]) request({ 'Action' => 'ApplySecurityGroupsToLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::ApplySecurityGroupsToLoadBalancer.new }.merge!(params)) end |
#attach_load_balancer_to_subnets(subnet_ids, lb_name) ⇒ Object Also known as: enable_subnets
Enable a subnet for an existing ELB
Parameters
-
subnet_ids<~Array> - List of subnet ids to enable on ELB
-
lb_name<~String> - Load balancer to enable availability zones on
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘AttachLoadBalancerToSubnetsResult’<~Hash>:
-
‘Subnets’<~Array> - array of strings describing the subnet ids currently enabled
-
-
-
21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/attach_load_balancer_to_subnets.rb', line 21 def attach_load_balancer_to_subnets(subnet_ids, lb_name) params = Fog::AWS.indexed_param('Subnets.member', [*subnet_ids]) request({ 'Action' => 'AttachLoadBalancerToSubnets', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::AttachLoadBalancerToSubnets.new }.merge!(params)) end |
#configure_health_check(lb_name, health_check) ⇒ Object
Enables the client to define an application healthcheck for the instances. See docs.amazonwebservices.com/ElasticLoadBalancing/latest/APIReference/index.html?API_ConfigureHealthCheck.html
Parameters
-
lb_name<~String> - Name of the ELB
-
health_check<~Hash> - A hash of parameters describing the health check
-
‘HealthyThreshold’<~Integer> - Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
-
‘Interval’<~Integer> - Specifies the approximate interval, in seconds, between health checks of an individual instance.
-
‘Target’<~String> - Specifies the instance being checked. The protocol is either TCP or HTTP. The range of valid ports is one (1) through 65535.
-
‘Timeout’<~Integer> - Specifies the amount of time, in seconds,
during which no response means a failed health probe.
-
‘UnhealthyThreshold’<~Integer> - Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
28 29 30 31 32 33 34 35 36 |
# File 'lib/fog/aws/requests/elb/configure_health_check.rb', line 28 def configure_health_check(lb_name, health_check) params = {'LoadBalancerName' => lb_name} health_check.each {|key, value| params["HealthCheck.#{key}"] = value } request({ 'Action' => 'ConfigureHealthCheck', :parser => Fog::Parsers::AWS::ELB::ConfigureHealthCheck.new }.merge!(params)) end |
#create_app_cookie_stickiness_policy(lb_name, policy_name, cookie_name) ⇒ Object
Create an app cookie stickiness policy
Parameters
-
lb_name<~String> - Name of the ELB
-
policy_name<~String> - The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
-
cookie_name<~String> - Name of the application cookie used for stickiness.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
20 21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/create_app_cookie_stickiness_policy.rb', line 20 def (lb_name, policy_name, ) params = {'CookieName' => , 'PolicyName' => policy_name} request({ 'Action' => 'CreateAppCookieStickinessPolicy', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#create_lb_cookie_stickiness_policy(lb_name, policy_name, cookie_expiration_period = nil) ⇒ Object
Create a Load Balancer Cookie Stickiness Policy
Parameters
-
lb_name<~String> - Name of the ELB
-
policy_name<~String> - The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.
-
cookie_expiration_period<~Integer> - The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
22 23 24 25 26 27 28 29 30 |
# File 'lib/fog/aws/requests/elb/create_lb_cookie_stickiness_policy.rb', line 22 def (lb_name, policy_name, =nil) params = {'PolicyName' => policy_name, 'CookieExpirationPeriod' => } request({ 'Action' => 'CreateLBCookieStickinessPolicy', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#create_load_balancer(availability_zones, lb_name, listeners, options = {}) ⇒ Object
Create a new Elastic Load Balancer
Parameters
-
availability_zones<~Array> - List of availability zones for the ELB
-
lb_name<~String> - Name for the new ELB – must be unique
-
listeners<~Array> - Array of Hashes describing ELB listeners to assign to the ELB
-
‘Protocol’<~String> - Protocol to use. Either HTTP, HTTPS, TCP or SSL.
-
‘LoadBalancerPort’<~Integer> - The port that the ELB will listen to for outside traffic
-
‘InstancePort’<~Integer> - The port on the instance that the ELB will forward traffic to
-
‘InstanceProtocol’<~String> - Protocol for sending traffic to an instance. Either HTTP, HTTPS, TCP or SSL.
-
‘SSLCertificateId’<~String> - ARN of the server certificate
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘CreateLoadBalancerResult’<~Hash>:
-
‘DNSName’<~String> - DNS name for the newly created ELB
-
-
-
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/fog/aws/requests/elb/create_load_balancer.rb', line 26 def create_load_balancer(availability_zones, lb_name, listeners, = {}) params = Fog::AWS.indexed_param('AvailabilityZones.member', [*availability_zones]) params.merge!(Fog::AWS.indexed_param('Subnets.member.%d', [:subnet_ids])) params.merge!(Fog::AWS.serialize_keys('Scheme', [:scheme])) params.merge!(Fog::AWS.indexed_param('SecurityGroups.member.%d', [:security_groups])) listener_protocol = [] listener_lb_port = [] listener_instance_port = [] listener_instance_protocol = [] listener_ssl_certificate_id = [] listeners.each do |listener| listener_protocol.push(listener['Protocol']) listener_lb_port.push(listener['LoadBalancerPort']) listener_instance_port.push(listener['InstancePort']) listener_instance_protocol.push(listener['InstanceProtocol']) listener_ssl_certificate_id.push(listener['SSLCertificateId']) end params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.Protocol', listener_protocol)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.LoadBalancerPort', listener_lb_port)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.InstancePort', listener_instance_port)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.InstanceProtocol', listener_instance_protocol)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.SSLCertificateId', listener_ssl_certificate_id)) request({ 'Action' => 'CreateLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::CreateLoadBalancer.new }.merge!(params)) end |
#create_load_balancer_listeners(lb_name, listeners) ⇒ Object
Create Elastic Load Balancer Listeners
Parameters
-
lb_name<~String> - Name for the new ELB – must be unique
-
listeners<~Array> - Array of Hashes describing ELB listeners to add to the ELB
-
‘Protocol’<~String> - Protocol to use. Either HTTP, HTTPS, TCP or SSL.
-
‘LoadBalancerPort’<~Integer> - The port that the ELB will listen to for outside traffic
-
‘InstancePort’<~Integer> - The port on the instance that the ELB will forward traffic to
-
‘InstanceProtocol’<~String> - Protocol for sending traffic to an instance. Either HTTP, HTTPS, TCP or SSL.
-
‘SSLCertificateId’<~String> - ARN of the server certificate
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
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 50 |
# File 'lib/fog/aws/requests/elb/create_load_balancer_listeners.rb', line 23 def create_load_balancer_listeners(lb_name, listeners) params = {} listener_protocol = [] listener_lb_port = [] listener_instance_port = [] listener_instance_protocol = [] listener_ssl_certificate_id = [] listeners.each do |listener| listener_protocol.push(listener['Protocol']) listener_lb_port.push(listener['LoadBalancerPort']) listener_instance_port.push(listener['InstancePort']) listener_instance_protocol.push(listener['InstanceProtocol']) listener_ssl_certificate_id.push(listener['SSLCertificateId']) end params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.Protocol', listener_protocol)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.LoadBalancerPort', listener_lb_port)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.InstancePort', listener_instance_port)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.InstanceProtocol', listener_instance_protocol)) params.merge!(Fog::AWS.indexed_param('Listeners.member.%d.SSLCertificateId', listener_ssl_certificate_id)) request({ 'Action' => 'CreateLoadBalancerListeners', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#create_load_balancer_policy(lb_name, name, type_name, attributes = {}) ⇒ Object
Create Elastic Load Balancer Policy
Parameters
-
lb_name<~String> - The name associated with the LoadBalancer for which the policy is being created. This name must be unique within the client AWS account.
-
attributes<~Hash> - A list of attributes associated with the policy being created.
-
‘AttributeName’<~String> - The name of the attribute associated with the policy.
-
‘AttributeValue’<~String> - The value of the attribute associated with the policy.
-
-
name<~String> - The name of the LoadBalancer policy being created. The name must be unique within the set of policies for this LoadBalancer.
-
type_name<~String> - The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/fog/aws/requests/elb/create_load_balancer_policy.rb', line 22 def create_load_balancer_policy(lb_name, name, type_name, attributes = {}) params = {} attribute_name = [] attribute_value = [] attributes.each do |name, value| attribute_name.push(name) attribute_value.push(value) end params.merge!(Fog::AWS.indexed_param('PolicyAttributes.member.%d.AttributeName', attribute_name)) params.merge!(Fog::AWS.indexed_param('PolicyAttributes.member.%d.AttributeValue', attribute_value)) request({ 'Action' => 'CreateLoadBalancerPolicy', 'LoadBalancerName' => lb_name, 'PolicyName' => name, 'PolicyTypeName' => type_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#delete_load_balancer(lb_name) ⇒ Object
Delete an existing Elastic Load Balancer
Note that this API call, as defined by Amazon, is idempotent. That is, it will not return an error if you try to delete an ELB that does not exist.
Parameters
-
lb_name<~String> - Name of the ELB to be deleted
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘DeleteLoadBalancerResponse’<~nil>
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/delete_load_balancer.rb', line 22 def delete_load_balancer(lb_name) request({ 'Action' => 'DeleteLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DeleteLoadBalancer.new }) end |
#delete_load_balancer_listeners(lb_name, load_balancer_ports) ⇒ Object
Delet Elastic Load Balancer Listeners
Parameters
-
lb_name<~String> - Name for the new ELB – must be unique
-
load_balancer_ports<~Array> - Array of client port numbers of the LoadBalancerListeners to remove
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
18 19 20 21 22 23 24 25 26 |
# File 'lib/fog/aws/requests/elb/delete_load_balancer_listeners.rb', line 18 def delete_load_balancer_listeners(lb_name, load_balancer_ports) params = Fog::AWS.indexed_param('LoadBalancerPorts.member.%d', load_balancer_ports) request({ 'Action' => 'DeleteLoadBalancerListeners', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#delete_load_balancer_policy(lb_name, policy_name) ⇒ Object
Delete a Load Balancer Stickiness Policy
Parameters
-
lb_name<~String> - Name of the ELB
-
policy_name<~String> - The name of the policy to delete
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
18 19 20 21 22 23 24 25 26 |
# File 'lib/fog/aws/requests/elb/delete_load_balancer_policy.rb', line 18 def delete_load_balancer_policy(lb_name, policy_name) params = {'PolicyName' => policy_name} request({ 'Action' => 'DeleteLoadBalancerPolicy', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |
#deregister_instances_from_load_balancer(instance_ids, lb_name) ⇒ Object Also known as: deregister_instances
Deregister an instance from an existing ELB
Parameters
-
instance_ids<~Array> - List of instance IDs to remove from ELB
-
lb_name<~String> - Load balancer to remove instances from
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DeregisterInstancesFromLoadBalancerResult’<~Hash>:
-
‘Instances’<~Array> - array of hashes describing instances currently enabled
-
‘InstanceId’<~String>
-
-
-
-
22 23 24 25 26 27 28 29 |
# File 'lib/fog/aws/requests/elb/deregister_instances_from_load_balancer.rb', line 22 def deregister_instances_from_load_balancer(instance_ids, lb_name) params = Fog::AWS.indexed_param('Instances.member.%d.InstanceId', [*instance_ids]) request({ 'Action' => 'DeregisterInstancesFromLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DeregisterInstancesFromLoadBalancer.new }.merge!(params)) end |
#describe_instance_health(lb_name, instance_ids = []) ⇒ Object
Get health status for one or more instances on an existing ELB
Parameters
-
lb_name<~String> - Load balancer to check instances health on
-
instance_ids<~Array> - Optional list of instance IDs to check
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DescribeInstanceHealthResult’<~Hash>:
-
‘InstanceStates’<~Array> - array of hashes describing instance health
-
‘Description’<~String>
-
‘State’<~String>
-
‘InstanceId’<~String>
-
‘ReasonCode’<~String>
-
-
-
-
25 26 27 28 29 30 31 32 |
# File 'lib/fog/aws/requests/elb/describe_instance_health.rb', line 25 def describe_instance_health(lb_name, instance_ids = []) params = Fog::AWS.indexed_param('Instances.member.%d.InstanceId', [*instance_ids]) request({ 'Action' => 'DescribeInstanceHealth', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DescribeInstanceHealth.new }.merge!(params)) end |
#describe_load_balancer_policies(lb_name = nil, names = []) ⇒ Object
Describe all or specified load balancer policies
Parameters
-
lb_name<~String> - The mnemonic name associated with the LoadBalancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.
-
names<~Array> - The names of LoadBalancer policies you’ve created or Elastic Load Balancing sample policy names.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DescribeLoadBalancerPoliciesResult’<~Hash>:
-
‘PolicyDescriptions’<~Array>
-
‘PolicyAttributeDescriptions’<~Array>
-
‘AttributeName’<~String> - The name of the attribute associated with the policy.
-
‘AttributeValue’<~String> - The value of the attribute associated with the policy.
-
-
‘PolicyName’<~String> - The name mof the policy associated with the LoadBalancer.
-
‘PolicyTypeName’<~String> - The name of the policy type.
-
-
-
-
26 27 28 29 30 31 32 33 |
# File 'lib/fog/aws/requests/elb/describe_load_balancer_policies.rb', line 26 def describe_load_balancer_policies(lb_name = nil, names = []) params = Fog::AWS.indexed_param('PolicyNames.member', [*names]) request({ 'Action' => 'DescribeLoadBalancerPolicies', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DescribeLoadBalancerPolicies.new }.merge!(params)) end |
#describe_load_balancer_policy_types(type_names = []) ⇒ Object
Describe all or specified load balancer policy types
Parameters
-
type_name<~Array> - Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DescribeLoadBalancerPolicyTypesResult’<~Hash>:
-
‘PolicyTypeDescriptions’<~Array>
-
‘Description’<~String> - A human-readable description of the policy type.
-
‘PolicyAttributeTypeDescriptions’<~Array>
-
‘AttributeName’<~String> - The name of the attribute associated with the policy type.
-
‘AttributeValue’<~String> - The type of attribute. For example, Boolean, Integer, etc.
-
‘Cardinality’<~String> - The cardinality of the attribute.
-
‘DefaultValue’<~String> - The default value of the attribute, if applicable.
-
‘Description’<~String> - A human-readable description of the attribute.
-
-
‘PolicyTypeName’<~String> - The name of the policy type.
-
-
-
-
28 29 30 31 32 33 34 |
# File 'lib/fog/aws/requests/elb/describe_load_balancer_policy_types.rb', line 28 def describe_load_balancer_policy_types(type_names = []) params = Fog::AWS.indexed_param('PolicyTypeNames.member', [*type_names]) request({ 'Action' => 'DescribeLoadBalancerPolicyTypes', :parser => Fog::Parsers::AWS::ELB::DescribeLoadBalancerPolicyTypes.new }.merge!(params)) end |
#describe_load_balancers(options = {}) ⇒ Object
Describe all or specified load balancers
Parameters
-
options<~Hash>
-
‘LoadBalancerNames’<~Array> - List of load balancer names to describe, defaults to all
-
‘Marker’<String> - Indicates where to begin in your list of load balancers
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DescribeLoadBalancersResult’<~Hash>:
-
‘LoadBalancerDescriptions’<~Array>
-
‘AvailabilityZones’<~Array> - list of availability zones covered by this load balancer
-
‘CanonicalHostedZoneName’<~String> - name of the Route 53 hosted zone associated with the load balancer
-
‘CanonicalHostedZoneNameID’<~String> - ID of the Route 53 hosted zone associated with the load balancer
-
‘CreatedTime’<~Time> - time load balancer was created
-
‘DNSName’<~String> - external DNS name of load balancer
-
‘HealthCheck’<~Hash>:
-
‘HealthyThreshold’<~Integer> - number of consecutive health probe successes required before moving the instance to the Healthy state
-
‘Timeout’<~Integer> - number of seconds after which no response means a failed health probe
-
‘Interval’<~Integer> - interval (in seconds) between health checks of an individual instance
-
‘UnhealthyThreshold’<~Integer> - number of consecutive health probe failures that move the instance to the unhealthy state
-
‘Target’<~String> - string describing protocol type, port and URL to check
-
-
‘Instances’<~Array> - list of instances that the load balancer balances between
-
‘ListenerDescriptions’<~Array>
-
‘PolicyNames’<~Array> - list of policies enabled
-
‘Listener’<~Hash>:
-
‘InstancePort’<~Integer> - port on instance that requests are sent to
-
‘Protocol’<~String> - transport protocol used for routing in [TCP, HTTP]
-
‘LoadBalancerPort’<~Integer> - port that load balancer listens on for requests
-
-
-
‘LoadBalancerName’<~String> - name of load balancer
-
‘Policies’<~Hash>:
-
‘LBCookieStickinessPolicies’<~Array> - list of Load Balancer Generated Cookie Stickiness policies for the LoadBalancer
-
‘AppCookieStickinessPolicies’<~Array> - list of Application Generated Cookie Stickiness policies for the LoadBalancer
-
-
‘SourceSecurityGroup’<~Hash>:
-
‘GroupName’<~String> - Name of the source security group to use with inbound security group rules
-
‘OwnerAlias’<~String> - Owner of the source security group
-
-
‘NextMarker’<~String> - Marker to specify for next page
-
-
-
-
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/fog/aws/requests/elb/describe_load_balancers.rb', line 48 def describe_load_balancers( = {}) unless .is_a?(Hash) Fog::Logger.deprecation("describe_load_balancers with #{.class} is deprecated, use all('LoadBalancerNames' => []) instead [light_black](#{caller.first})[/]") = { 'LoadBalancerNames' => [].flatten } end if names = .delete('LoadBalancerNames') .update(Fog::AWS.indexed_param('LoadBalancerNames.member', [*names])) end request({ 'Action' => 'DescribeLoadBalancers', :parser => Fog::Parsers::AWS::ELB::DescribeLoadBalancers.new }.merge!()) end |
#detach_load_balancer_from_subnets(subnet_ids, lb_name) ⇒ Object Also known as: disable_subnets
Disable a subnet for an existing ELB
Parameters
-
subnet_ids<~Array> - List of subnet ids to enable on ELB
-
lb_name<~String> - Load balancer to disable availability zones on
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DetachLoadBalancerFromSubnetsResult’<~Hash>:
-
‘Subnets’<~Array> - array of strings describing the subnet ids currently enabled
-
-
-
21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/detach_load_balancer_from_subnets.rb', line 21 def detach_load_balancer_from_subnets(subnet_ids, lb_name) params = Fog::AWS.indexed_param('Subnets.member', [*subnet_ids]) request({ 'Action' => 'DetachLoadBalancerFromSubnets', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DetachLoadBalancerFromSubnets.new }.merge!(params)) end |
#disable_availability_zones_for_load_balancer(availability_zones, lb_name) ⇒ Object Also known as: disable_zones
Disable an availability zone for an existing ELB
Parameters
-
availability_zones<~Array> - List of availability zones to disable on ELB
-
lb_name<~String> - Load balancer to disable availability zones on
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘DisableAvailabilityZonesForLoadBalancerResult’<~Hash>:
-
‘AvailabilityZones’<~Array> - A list of updated Availability Zones for the LoadBalancer.
-
-
-
21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/disable_availability_zones_for_load_balancer.rb', line 21 def disable_availability_zones_for_load_balancer(availability_zones, lb_name) params = Fog::AWS.indexed_param('AvailabilityZones.member', [*availability_zones]) request({ 'Action' => 'DisableAvailabilityZonesForLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::DisableAvailabilityZonesForLoadBalancer.new }.merge!(params)) end |
#enable_availability_zones_for_load_balancer(availability_zones, lb_name) ⇒ Object Also known as: enable_zones
Enable an availability zone for an existing ELB
Parameters
-
availability_zones<~Array> - List of availability zones to enable on ELB
-
lb_name<~String> - Load balancer to enable availability zones on
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘EnableAvailabilityZonesForLoadBalancerResult’<~Hash>:
-
‘AvailabilityZones’<~Array> - array of strings describing instances currently enabled
-
-
-
21 22 23 24 25 26 27 28 |
# File 'lib/fog/aws/requests/elb/enable_availability_zones_for_load_balancer.rb', line 21 def enable_availability_zones_for_load_balancer(availability_zones, lb_name) params = Fog::AWS.indexed_param('AvailabilityZones.member', [*availability_zones]) request({ 'Action' => 'EnableAvailabilityZonesForLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::EnableAvailabilityZonesForLoadBalancer.new }.merge!(params)) end |
#register_instances_with_load_balancer(instance_ids, lb_name) ⇒ Object Also known as: register_instances
Register an instance with an existing ELB
Parameters
-
instance_ids<~Array> - List of instance IDs to associate with ELB
-
lb_name<~String> - Load balancer to assign instances to
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
‘RegisterInstancesWithLoadBalancerResult’<~Hash>:
-
‘Instances’<~Array> - array of hashes describing instances currently enabled
-
‘InstanceId’<~String>
-
-
-
-
22 23 24 25 26 27 28 29 |
# File 'lib/fog/aws/requests/elb/register_instances_with_load_balancer.rb', line 22 def register_instances_with_load_balancer(instance_ids, lb_name) params = Fog::AWS.indexed_param('Instances.member.%d.InstanceId', [*instance_ids]) request({ 'Action' => 'RegisterInstancesWithLoadBalancer', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::RegisterInstancesWithLoadBalancer.new }.merge!(params)) end |
#reload ⇒ Object
140 141 142 |
# File 'lib/fog/aws/elb.rb', line 140 def reload @connection.reset end |
#set_load_balancer_listener_ssl_certificate(lb_name, load_balancer_port, ssl_certificate_id) ⇒ Object
Sets the certificate that terminates the specified listener’s SSL connections. The specified certificate replaces any prior certificate that was used on the same LoadBalancer and port.
Parameters
-
lb_name<~String> - Name of the ELB
-
load_balancer_port<~Integer> - The external port of the LoadBalancer with which this policy has to be associated.
-
ssl_certificate_id<~String> - ID of the SSL certificate chain to use example: arn:aws:iam::322191361670:server-certificate/newCert
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
24 25 26 27 28 29 30 31 32 |
# File 'lib/fog/aws/requests/elb/set_load_balancer_listener_ssl_certificate.rb', line 24 def set_load_balancer_listener_ssl_certificate(lb_name, load_balancer_port, ssl_certificate_id) request({ 'Action' => 'SetLoadBalancerListenerSSLCertificate', 'LoadBalancerName' => lb_name, 'LoadBalancerPort' => load_balancer_port, 'SSLCertificateId' => ssl_certificate_id, :parser => Fog::Parsers::AWS::ELB::Empty.new }) end |
#set_load_balancer_policies_of_listener(lb_name, load_balancer_port, policy_names) ⇒ Object
-
policy_names<~Array> - List of policies to be associated with the listener. Currently this list can have at most one policy. If the list is empty, the current policy is removed from the listener.
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResponseMetadata’<~Hash>:
-
‘RequestId’<~String> - Id of request
-
-
-
25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# File 'lib/fog/aws/requests/elb/set_load_balancer_policies_of_listener.rb', line 25 def set_load_balancer_policies_of_listener(lb_name, load_balancer_port, policy_names) params = {'LoadBalancerPort' => load_balancer_port} if policy_names.any? params.merge!(Fog::AWS.indexed_param('PolicyNames.member', policy_names)) else params['PolicyNames'] = '' end request({ 'Action' => 'SetLoadBalancerPoliciesOfListener', 'LoadBalancerName' => lb_name, :parser => Fog::Parsers::AWS::ELB::Empty.new }.merge!(params)) end |