AWS.ElasticLoadBalancingv2 (aws-elixir v0.8.0) View Source

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, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:

  • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

  • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

  • Gateway Load Balancer - Operates at the network layer (layer 3).

For more information, see the Elastic Load Balancing User Guide.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

Link to this section Summary

Functions

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

Adds the specified tags to the specified Elastic Load Balancing resource.

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Creates a rule for the specified listener.

Deletes the specified listener.

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Deletes the specified rule.

Deletes the specified target group.

Deregisters the specified targets from the specified target group.

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

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

Describes the specified rules or the rules for the specified listener.

Describes the specified policies or all policies used for SSL negotiation.

Describes the tags for the specified Elastic Load Balancing resources.

Describes the attributes for the specified target group.

Describes the specified target groups or all of your target groups.

Describes the health of the specified targets or all of your targets.

Replaces the specified properties of the specified listener.

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Replaces the specified properties of 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 certificate from the certificate list for the specified HTTPS or TLS listener.

Removes the specified tags from the specified Elastic Load Balancing resources.

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.

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer.

Link to this section Functions

Link to this function

add_listener_certificates(client, input, options \\ [])

View Source

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide.

Link to this function

add_tags(client, input, options \\ [])

View Source

Adds the specified tags to the specified Elastic Load Balancing resource.

You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.

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.

Link to this function

create_listener(client, input, options \\ [])

View Source

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.

Link to this function

create_load_balancer(client, input, options \\ [])

View Source

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

Link to this function

create_rule(client, input, options \\ [])

View Source

Creates a rule for the specified listener.

The listener must be associated with an Application Load Balancer.

Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.

Link to this function

create_target_group(client, input, options \\ [])

View Source

Creates a target group.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

Link to this function

delete_listener(client, input, options \\ [])

View Source

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer to which it is attached.

Link to this function

delete_load_balancer(client, input, options \\ [])

View Source

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Deleting a load balancer also deletes its 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.

Link to this function

delete_rule(client, input, options \\ [])

View Source

Deletes the specified rule.

You can't delete the default rule.

Link to this function

delete_target_group(client, input, options \\ [])

View Source

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. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.

Link to this function

deregister_targets(client, input, options \\ [])

View Source

Deregisters the specified targets from the specified target group.

After the targets are deregistered, they no longer receive traffic from the load balancer.

Link to this function

describe_account_limits(client, input, options \\ [])

View Source

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.

For more information, see the following:

Link to this function

describe_listener_certificates(client, input, options \\ [])

View Source

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

Link to this function

describe_listeners(client, input, options \\ [])

View Source

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

You must specify either a load balancer or one or more listeners.

Link to this function

describe_load_balancer_attributes(client, input, options \\ [])

View Source

Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

Link to this function

describe_load_balancers(client, input, options \\ [])

View Source

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

Link to this function

describe_rules(client, input, options \\ [])

View Source

Describes the specified rules or the rules for the specified listener.

You must specify either a listener or one or more rules.

Link to this function

describe_ssl_policies(client, input, options \\ [])

View Source

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.

Link to this function

describe_tags(client, input, options \\ [])

View Source

Describes the tags for the specified Elastic Load Balancing resources.

You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Link to this function

describe_target_group_attributes(client, input, options \\ [])

View Source

Describes the attributes for the specified target group.

For more information, see the following:

Link to this function

describe_target_groups(client, input, options \\ [])

View Source

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.

Link to this function

describe_target_health(client, input, options \\ [])

View Source

Describes the health of the specified targets or all of your targets.

Link to this function

modify_listener(client, input, options \\ [])

View Source

Replaces the specified properties of the specified listener.

Any properties that you do not specify remain unchanged.

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Link to this function

modify_load_balancer_attributes(client, input, options \\ [])

View Source

Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway 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.

Link to this function

modify_rule(client, input, options \\ [])

View Source

Replaces the specified properties of the specified rule.

Any properties that you do not specify are unchanged.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Link to this function

modify_target_group(client, input, options \\ [])

View Source

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

Link to this function

modify_target_group_attributes(client, input, options \\ [])

View Source

Modifies the specified attributes of the specified target group.

Link to this function

register_targets(client, input, options \\ [])

View Source

Registers the specified targets with the specified target group.

If the target is an EC2 instance, it must be in the running state when you register it.

By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.

Link to this function

remove_listener_certificates(client, input, options \\ [])

View Source

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

Link to this function

remove_tags(client, input, options \\ [])

View Source

Removes the specified tags from the specified Elastic Load Balancing resources.

You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.

Link to this function

set_ip_address_type(client, input, options \\ [])

View Source

Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

Link to this function

set_rule_priorities(client, input, options \\ [])

View Source

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.

Link to this function

set_security_groups(client, input, options \\ [])

View Source

Associates the specified security groups with the specified Application Load Balancer.

The specified security groups override the previously associated security groups.

You can't specify a security group for a Network Load Balancer or Gateway Load Balancer.

Link to this function

set_subnets(client, input, options \\ [])

View Source

Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer.

The specified subnets replace the previously enabled subnets.

When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.