@aws-sdk/client-elastic-load-balancing-node

Description

Elastic Load Balancing

A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. 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 and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

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

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-elastic-load-balancing-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(ElasticLoadBalancingClient) and the commands you need, for example AddTagsCommand:

//JavaScript
const {
  ElasticLoadBalancingClient
} = require("@aws-sdk/client-elastic-load-balancing-node/ElasticLoadBalancingClient");
const {
  AddTagsCommand
} = require("@aws-sdk/client-elastic-load-balancing-node/commands/AddTagsCommand");

//TypeScript
import { ElasticLoadBalancingClient } from "@aws-sdk/client-elastic-load-balancing-node/ElasticLoadBalancingClient";
import { AddTagsCommand } from "@aws-sdk/client-elastic-load-balancing-node/commands/AddTagsCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

const elasticLoadBalancing = new ElasticLoadBalancingClient({
  region: "region"
});
//clients can be shared by different commands
const params = {
  LoadBalancerNames: [
    /**a list of string*/
  ],
  Tags: [
    /**a list of structure*/
  ]
};
const addTagsCommand = new AddTagsCommand(params);
elasticLoadBalancing
  .send(addTagsCommand)
  .then(data => {
    // do something
  })
  .catch(error => {
    // error handling
  });

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await elasticLoadBalancing.send(addTagsCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
elasticLoadBalancing.send(addTagsCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-elastic-load-balancing-node/ElasticLoadBalancing";
const elasticLoadBalancing = new AWS.ElasticLoadBalancing({ region: "region" });
elasticLoadBalancing.addTags(params, (err, data) => {
  //do something
});

Troubleshooting

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 elasticLoadBalancing.send(addTagsCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-elastic-load-balancing-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.