ElasticLoadBalancingV2Client
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.
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. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules.
Adds the specified revocation file to the specified trust store.
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. The listener must be associated with an Application Load Balancer.
Creates a target group.
Creates a trust store.
Deletes the specified listener.
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
Deletes the specified rule.
Deletes the specified target group.
Deletes a trust store.
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 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. You must specify either a load balancer or one or more listeners.
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. 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 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.
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.
Describes all resources associated with the specified trust store.
Describes the revocation files in use by the specified trust store arn, or revocation ID.
Describes all trust stores for a given account by trust store arn’s or name.
Retrieves the ca certificate bundle.
Retrieves the specified revocation file.
Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
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. Any properties that you do not specify are unchanged.
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.
Update the ca certificate bundle for a given trust store.
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. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
Removes the specified revocation file from the specified trust store.
Sets the type of IP addresses used by the subnets of the specified load balancer.
Sets the priorities of the specified rules.
Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
Inherited 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. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules.
Adds the specified revocation file to the specified trust store.
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. The listener must be associated with an Application Load Balancer.
Creates a target group.
Creates a trust store.
Deletes the specified listener.
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
Deletes the specified rule.
Deletes the specified target group.
Deletes a trust store.
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 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. You must specify either a load balancer or one or more listeners.
Paginate over DescribeListenersResponse results.
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.
Paginate over DescribeLoadBalancersResponse results.
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 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.
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.
Paginate over DescribeTargetGroupsResponse results.
Describes the health of the specified targets or all of your targets.
Describes all resources associated with the specified trust store.
Paginate over DescribeTrustStoreAssociationsResponse results.
Describes the revocation files in use by the specified trust store arn, or revocation ID.
Paginate over DescribeTrustStoreRevocationsResponse results.
Describes all trust stores for a given account by trust store arn’s or name.
Paginate over DescribeTrustStoresResponse results.
Retrieves the ca certificate bundle.
Retrieves the specified revocation file.
Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
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. Any properties that you do not specify are unchanged.
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.
Update the ca certificate bundle for a given trust store.
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. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
Removes the specified revocation file from the specified trust store.
Sets the type of IP addresses used by the subnets of the specified load balancer.
Sets the priorities of the specified rules.
Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.
Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.