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.

Installation

NPM
npm install @aws-sdk/client-elastic-load-balancing-v2
Yarn
yarn add @aws-sdk/client-elastic-load-balancing-v2
pnpm
pnpm add @aws-sdk/client-elastic-load-balancing-v2

ElasticLoadBalancingV2Client Operations

Command
Summary
AddListenerCertificatesCommand

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.

AddTagsCommand

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.

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.

AddTrustStoreRevocationsCommand

Adds the specified revocation file to the specified trust store.

CreateListenerCommand

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.

CreateLoadBalancerCommand

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.

CreateRuleCommand

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.

CreateTargetGroupCommand

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.

CreateTrustStoreCommand

Creates a trust store.

DeleteListenerCommand

Deletes the specified listener.

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

DeleteLoadBalancerCommand

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.

DeleteRuleCommand

Deletes the specified rule.

You can't delete the default rule.

DeleteSharedTrustStoreAssociationCommand

Deletes a shared trust store association.

DeleteTargetGroupCommand

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.

DeleteTrustStoreCommand

Deletes a trust store.

DeregisterTargetsCommand

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.

For more information, see the following:

Note: If the specified target does not exist, the action returns successfully.

DescribeAccountLimitsCommand

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

For more information, see the following:

DescribeCapacityReservationCommand

Describes the capacity reservation status for the specified load balancer.

DescribeListenerAttributesCommand

Describes the attributes for the specified listener.

DescribeListenerCertificatesCommand

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.

DescribeListenersCommand

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.

DescribeLoadBalancerAttributesCommand

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

For more information, see the following:

DescribeLoadBalancersCommand

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

DescribeRulesCommand

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

DescribeSSLPoliciesCommand

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.

DescribeTagsCommand

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.

DescribeTargetGroupAttributesCommand

Describes the attributes for the specified target group.

For more information, see the following:

DescribeTargetGroupsCommand

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.

DescribeTargetHealthCommand

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

DescribeTrustStoreAssociationsCommand

Describes all resources associated with the specified trust store.

DescribeTrustStoreRevocationsCommand

Describes the revocation files in use by the specified trust store or revocation files.

DescribeTrustStoresCommand

Describes all trust stores for the specified account.

GetResourcePolicyCommand

Retrieves the resource policy for a specified resource.

GetTrustStoreCaCertificatesBundleCommand

Retrieves the ca certificate bundle.

This action returns a pre-signed S3 URI which is active for ten minutes.

GetTrustStoreRevocationContentCommand

Retrieves the specified revocation file.

This action returns a pre-signed S3 URI which is active for ten minutes.

ModifyCapacityReservationCommand

Modifies the capacity reservation of the specified load balancer.

When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity or ResetCapacityReservation.

ModifyListenerAttributesCommand

Modifies the specified attributes of the specified listener.

ModifyListenerCommand

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.

ModifyLoadBalancerAttributesCommand

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.

ModifyRuleCommand

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.

ModifyTargetGroupAttributesCommand

Modifies the specified attributes of the specified target group.

ModifyTargetGroupCommand

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

ModifyTrustStoreCommand

Update the ca certificate bundle for the specified trust store.

RegisterTargetsCommand

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 can't 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.

RemoveListenerCertificatesCommand

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

RemoveTagsCommand

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.

RemoveTrustStoreRevocationsCommand

Removes the specified revocation file from the specified trust store.

SetIpAddressTypeCommand

Sets the type of IP addresses used by the subnets of the specified load balancer.

SetRulePrioritiesCommand

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.

SetSecurityGroupsCommand

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.

You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.

You can't associate a security group with a Gateway Load Balancer.

SetSubnetsCommand

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.

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

ElasticLoadBalancingV2Client Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: ElasticLoadBalancingV2ClientConfig