@aws-sdk/client-elastic-load-balancing-v2
Advanced tools
AWS SDK for JavaScript Elastic Load Balancing V2 Client for Node.js, Browser and React Native
@aws-sdk/client-elastic-load-balancing-v2 is an AWS SDK for JavaScript package that allows developers to interact with the Elastic Load Balancing (ELB) service, specifically the Application Load Balancer (ALB) and Network Load Balancer (NLB). It provides a set of APIs to manage load balancers, target groups, listeners, and rules.
Create Load Balancer
This feature allows you to create a new load balancer. The code sample demonstrates how to create an Application Load Balancer with specified subnets, security groups, and other configurations.
const { ElasticLoadBalancingV2Client, CreateLoadBalancerCommand } = require('@aws-sdk/client-elastic-load-balancing-v2');
const client = new ElasticLoadBalancingV2Client({ region: 'us-west-2' });
const params = {
Name: 'my-load-balancer',
Subnets: ['subnet-12345678'],
SecurityGroups: ['sg-12345678'],
Scheme: 'internet-facing',
Type: 'application'
};
const command = new CreateLoadBalancerCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Create Target Group
This feature allows you to create a new target group. The code sample demonstrates how to create a target group with specified protocol, port, and VPC ID.
const { ElasticLoadBalancingV2Client, CreateTargetGroupCommand } = require('@aws-sdk/client-elastic-load-balancing-v2');
const client = new ElasticLoadBalancingV2Client({ region: 'us-west-2' });
const params = {
Name: 'my-target-group',
Protocol: 'HTTP',
Port: 80,
VpcId: 'vpc-12345678'
};
const command = new CreateTargetGroupCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Register Targets
This feature allows you to register targets with a target group. The code sample demonstrates how to register EC2 instances with a specified target group.
const { ElasticLoadBalancingV2Client, RegisterTargetsCommand } = require('@aws-sdk/client-elastic-load-balancing-v2');
const client = new ElasticLoadBalancingV2Client({ region: 'us-west-2' });
const params = {
TargetGroupArn: 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-target-group/abcdef123456',
Targets: [
{ Id: 'i-12345678' },
{ Id: 'i-87654321' }
]
};
const command = new RegisterTargetsCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Create Listener
This feature allows you to create a listener for a load balancer. The code sample demonstrates how to create an HTTP listener that forwards requests to a specified target group.
const { ElasticLoadBalancingV2Client, CreateListenerCommand } = require('@aws-sdk/client-elastic-load-balancing-v2');
const client = new ElasticLoadBalancingV2Client({ region: 'us-west-2' });
const params = {
LoadBalancerArn: 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/abcdef123456',
Protocol: 'HTTP',
Port: 80,
DefaultActions: [
{
Type: 'forward',
TargetGroupArn: 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-target-group/abcdef123456'
}
]
};
const command = new CreateListenerCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);The 'aws-sdk' package is the official AWS SDK for JavaScript. It provides a comprehensive set of APIs for interacting with all AWS services, including Elastic Load Balancing. Compared to '@aws-sdk/client-elastic-load-balancing-v2', it is a monolithic package that includes all AWS services, which can result in larger bundle sizes.
The 'serverless' package is a framework for building and deploying serverless applications on AWS and other cloud providers. It provides abstractions and tools for managing AWS resources, including load balancers. While it offers higher-level abstractions and easier deployment, it may not provide the same level of granular control as '@aws-sdk/client-elastic-load-balancing-v2'.
The 'terraform' package is an open-source infrastructure as code software tool created by HashiCorp. It allows users to define and provision data center infrastructure using a high-level configuration language. While it supports AWS ELB, it is a multi-cloud tool and not specific to JavaScript, offering a different approach to infrastructure management compared to '@aws-sdk/client-elastic-load-balancing-v2'.
AWS SDK for JavaScript ElasticLoadBalancingV2 Client for Node.js, Browser and React Native.
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.
To install this package, simply type add or install @aws-sdk/client-elastic-load-balancing-v2 using your favorite package manager:
npm install @aws-sdk/client-elastic-load-balancing-v2yarn add @aws-sdk/client-elastic-load-balancing-v2pnpm add @aws-sdk/client-elastic-load-balancing-v2The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ElasticLoadBalancingV2Client and
the commands you need, for example DescribeListenersCommand:
// ES5 example
const { ElasticLoadBalancingV2Client, DescribeListenersCommand } = require("@aws-sdk/client-elastic-load-balancing-v2");
// ES6+ example
import { ElasticLoadBalancingV2Client, DescribeListenersCommand } from "@aws-sdk/client-elastic-load-balancing-v2";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new ElasticLoadBalancingV2Client({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new DescribeListenersCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-elastic-load-balancing-v2";
const client = new AWS.ElasticLoadBalancingV2({ region: "REGION" });
// async/await.
try {
const data = await client.describeListeners(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeListeners(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.describeListeners(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-elastic-load-balancing-v2 package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.699.0 (2024-11-22)
FAQs
AWS SDK for JavaScript Elastic Load Balancing V2 Client for Node.js, Browser and React Native
We found that @aws-sdk/client-elastic-load-balancing-v2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket and Seal Security collaborate to fix a critical npm overrides bug, resolving a three-year security issue in the JavaScript ecosystem's most popular package manager.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.