ex_aws_elastic_load_balancing

v2.0.2

ex_aws_elastic_load_balancing v2.0.2 ExAws.ElasticLoadBalancing View Source

Operations on AWS ElasticLoadBalancing

AWS ElasticLoadBalancing provides a reliable, scalable, and flexible monitoring solution for your AWS resources. This module provides functionality for only classic load balancers. See ExAws.ElasticLoadBalancingV2 for the API for application and network load balancers.

More information:

Link to this section Summary

Types

describe_load_balancers_opts()

Functions

describe_load_balancers(opts \\ [])

Describes the specified load balancers or all of your load balancers

describe_tags(load_balancer_names)

DescribeTags API operation for Elastic Load Balancing

Link to this section Types

Link to this type

describe_load_balancers_opts() View Source 
describe_load_balancers_opts() :: [
  load_balancer_names: [binary(), ...],
  starting_token: binary(),
  max_items: integer(),
  page_size: integer()
]

Link to this section Functions

Link to this function

describe_load_balancers(opts \\ []) View Source 
describe_load_balancers(opts :: describe_load_balancers_opts()) ::
  ExAws.Operation.Query.t()

Describes the specified load balancers or all of your load balancers.

To describe the listeners for a load balancer, use describe_listeners/1. To describe the attributes for a load balancer, use describe_load_balancer_attributes/1.

The options that can be passed into describe_load_balancers/1 allow load_balancer_arns or names (there would not be a reason ordinarily to specify both). Elastic Load Balancing provides two versions of ARNS (one for Classic and one for Application Load Balancer). The syntax for each is below:

Classic Load Balancer ARN Syntax:

arn:aws:elasticloadbalancing:region:account-id:loadbalancer/name

Application Load Balancer ARN Syntax:

arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
arn:aws:elasticloadbalancing:region:account-id:listener/app/load-balancer-name/load-balancer-id/listener-id
arn:aws:elasticloadbalancing:region:account-id:listener-rule/app/load-balancer-name/load-balancer-id/listener-id/rule-id
arn:aws:elasticloadbalancing:region:account-id:targetgroup/target-group-name/target-group-id

Examples: 

iex> ExAws.ElasticLoadBalancing.describe_load_balancers
%ExAws.Operation.Query{action: :describe_load_balancers,
params: %{"Action" => "DescribeLoadBalancers", "Version" => "2012-06-01"},
parser: &ExAws.ElasticLoadBalancing.Parsers.parse/2, path: "/", service: :elasticloadbalancing}
Link to this function

describe_tags(load_balancer_names) View Source 
describe_tags(load_balancer_names :: [binary(), ...]) ::
  ExAws.Operation.Query.t()

DescribeTags API operation for Elastic Load Balancing.

Describes the tags associated with the specified load balancers.

A list of load balancer names is a required parameter

Examples: 

iex(1)> ExAws.ElasticLoadBalancing.describe_tags(["load_balancer_name1", "load_balancer_name2"])
%ExAws.Operation.Query{
  action: :describe_tags,
  params: %{
    "Action" => "DescribeTags",
    "LoadBalancerNames.member.1" => "load_balancer_name1",
    "LoadBalancerNames.member.2" => "load_balancer_name2",
    "Version" => "2012-06-01"
  },
  parser: &ExAws.ElasticLoadBalancing.Parsers.parse/2,
  path: "/",
  service: :elasticloadbalancing
}