baiji v0.6.0 Baiji.ElasticLoadBalancingv2
Elastic Load Balancing
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.
An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).
A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.
To get started, complete the following tasks:
- Create a load balancer using `CreateLoadBalancer`.
- Create a target group using `CreateTargetGroup`.
- Register targets for the target group using `RegisterTargets`.
- Create one or more listeners for your load balancer using `CreateListener`.
- Delete the load balancer using `DeleteLoadBalancer`.
- Delete the target group using `DeleteTargetGroup`.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups
Creates a listener for the specified Application Load Balancer or Network Load Balancer
Creates an Application Load Balancer or a Network Load Balancer
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer
Creates a target group
Deletes the specified listener
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners
Deletes the specified rule
Deletes the specified target group
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer
Describes the current Elastic Load Balancing resource limits for your AWS account
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners
Describes the attributes for the specified Application Load Balancer or Network Load Balancer
Describes the specified load balancers or all of your load balancers
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules
Describes the specified policies or all policies used for SSL negotiation
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups
Describes the attributes for the specified target group
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups
Describes the health of the specified targets or all of your targets
Modifies the specified properties of the specified listener
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer
Modifies the specified rule
Modifies the health checks used when evaluating the health state of the targets in the specified target group
Modifies the specified attributes of the specified target group
Registers the specified targets with the specified target group
Removes the specified tags from the specified Elastic Load Balancing resource
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer
Sets the priorities of the specified rules
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has
a tag with the same key, AddTags
updates its value.
To list the current tags for your resources, use DescribeTags
. To remove
tags from your resources, use RemoveTags
.
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
You can create up to 10 listeners per load balancer.
To update a listener, use ModifyListener
. When you are finished with a
listener, you can delete it using DeleteListener
. If you are finished
with both the listener and the load balancer, you can delete them both
using DeleteLoadBalancer
.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, subnets,
IP address type, and tags. Otherwise, you could do so later using
SetSecurityGroups
, SetSubnets
, SetIpAddressType
, and AddTags
.
To create listeners for your load balancer, use CreateListener
. To
describe your current load balancers, see DescribeLoadBalancers
. When you
are finished with a load balancer, you can delete it using
DeleteLoadBalancer
.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules
. To update a rule, use
ModifyRule
. To set the priorities of your rules, use SetRulePriorities
.
To delete a rule, use DeleteRule
.
Creates a target group.
To register targets with the target group, use RegisterTargets
. To update
the health check settings for the target group, use ModifyTargetGroup
. To
monitor the health of targets in the target group, use
DescribeTargetHealth
.
To route traffic to the targets in a target group, specify the target group
in an action using CreateListener
or CreateRule
.
To delete a target group, use DeleteTargetGroup
.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer
it is attached to using DeleteLoadBalancer
.
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can’t delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
Deletes the specified rule.
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners
. To
describe the attributes for a load balancer, use
DescribeLoadBalancerAttributes
.
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
Describes the attributes for the specified target group.
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth
. To
describe the attributes of a target group, use
DescribeTargetGroupAttributes
.
Describes the health of the specified targets or all of your targets.
Modifies the specified properties of the specified listener.
Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
If any of the specified attributes can’t be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
Modifies the specified rule.
Any existing properties that you do not modify retain their current values.
To modify the default action, use ModifyListener
.
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth
.
Modifies the specified attributes of the specified target group.
Registers the specified targets with the specified target group.
By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.
The target must be in the virtual private cloud (VPC) that you specified
for the target group. If the target is an EC2 instance, it must be in the
running
state when you register it.
Network Load Balancers do not support the following instance types as targets: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
To remove a target from a target group, use DeregisterTargets
.
Removes the specified tags from the specified Elastic Load Balancing resource.
To list the current tags for your resources, use DescribeTags
.
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
Note that Network Load Balancers must use ipv4
.
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.
Note that you can’t specify a security group for a Network Load Balancer.
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.
Note that you can’t change the subnets for a Network Load Balancer.