We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ELB

Inherits:
AWS.Service show all
Identifier:
elb
API Version:
2012-06-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using ELB

var elb = new AWS.ELB();
elb.addTags(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ELB object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var elb = new AWS.ELB({apiVersion: '2012-06-01'});

You can also set the API version globally in AWS.config.apiVersions using the elb service identifier:

AWS.config.apiVersions = {
  elb: '2012-06-01',
  // other service API versions
};

var elb = new AWS.ELB();

Version:

  • 2012-06-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

instanceDeregistered, anyInstanceInService, instanceInService

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ELB(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ELB object

var elb = new AWS.ELB({apiVersion: '2012-06-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ELB.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ELB.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ELB.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addTags(params = {}, callback) ⇒ AWS.Request

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

Service Reference:

Examples:

To add tags to a load balancer


/* This example adds two tags to the specified load balancer. */

 var params = {
  LoadBalancerNames: [
     "my-load-balancer"
  ], 
  Tags: [
     {
    Key: "project", 
    Value: "lima"
   }, 
     {
    Key: "department", 
    Value: "digital-media"
   }
  ]
 };
 elb.addTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the addTags operation

var params = {
  LoadBalancerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elb.addTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerNames — (Array<String>)

      The name of the load balancer. You can specify one load balancer only.

    • Tags — (Array<map>)

      The tags.

      • Keyrequired — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

applySecurityGroupsToLoadBalancer(params = {}, callback) ⇒ AWS.Request

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide.

Examples:

To associate a security group with a load balancer in a VPC


/* This example associates a security group with the specified load balancer in a VPC. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  SecurityGroups: [
     "sg-fc448899"
  ]
 };
 elb.applySecurityGroupsToLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SecurityGroups: [
       "sg-fc448899"
    ]
   }
   */
 });

Calling the applySecurityGroupsToLoadBalancer operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  SecurityGroups: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.applySecurityGroupsToLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • SecurityGroups — (Array<String>)

      The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroups — (Array<String>)

        The IDs of the security groups associated with the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

attachLoadBalancerToSubnets(params = {}, callback) ⇒ AWS.Request

Adds one or more subnets to the set of configured subnets for the specified load balancer.

The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide.

Service Reference:

Examples:

To attach subnets to a load balancer


/* This example adds the specified subnet to the set of configured subnets for the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  Subnets: [
     "subnet-0ecac448"
  ]
 };
 elb.attachLoadBalancerToSubnets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Subnets: [
       "subnet-15aaab61", 
       "subnet-0ecac448"
    ]
   }
   */
 });

Calling the attachLoadBalancerToSubnets operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  Subnets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.attachLoadBalancerToSubnets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Subnets — (Array<String>)

      The IDs of the subnets to add. You can add only one subnet per Availability Zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subnets — (Array<String>)

        The IDs of the subnets attached to the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

configureHealthCheck(params = {}, callback) ⇒ AWS.Request

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.

Service Reference:

Examples:

To specify the health check settings for your backend EC2 instances


/* This example specifies the health check settings used to evaluate the health of your backend EC2 instances. */

 var params = {
  HealthCheck: {
   HealthyThreshold: 2, 
   Interval: 30, 
   Target: "HTTP:80/png", 
   Timeout: 3, 
   UnhealthyThreshold: 2
  }, 
  LoadBalancerName: "my-load-balancer"
 };
 elb.configureHealthCheck(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    HealthCheck: {
     HealthyThreshold: 2, 
     Interval: 30, 
     Target: "HTTP:80/png", 
     Timeout: 3, 
     UnhealthyThreshold: 2
    }
   }
   */
 });

Calling the configureHealthCheck operation

var params = {
  HealthCheck: { /* required */
    HealthyThreshold: 'NUMBER_VALUE', /* required */
    Interval: 'NUMBER_VALUE', /* required */
    Target: 'STRING_VALUE', /* required */
    Timeout: 'NUMBER_VALUE', /* required */
    UnhealthyThreshold: 'NUMBER_VALUE' /* required */
  },
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.configureHealthCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • HealthCheck — (map)

      The configuration information.

      • Targetrequired — (String)

        The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

        TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

        SSL is also specified as SSL: port pair, for example, SSL:5000.

        For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

        The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

      • Intervalrequired — (Integer)

        The approximate interval, in seconds, between health checks of an individual instance.

      • Timeoutrequired — (Integer)

        The amount of time, in seconds, during which no response means a failed health check.

        This value must be less than the Interval value.

      • UnhealthyThresholdrequired — (Integer)

        The number of consecutive health check failures required before moving the instance to the Unhealthy state.

      • HealthyThresholdrequired — (Integer)

        The number of consecutive health checks successes required before moving the instance to the Healthy state.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheck — (map)

        The updated health check.

        • Targetrequired — (String)

          The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

          TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

          SSL is also specified as SSL: port pair, for example, SSL:5000.

          For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

          The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

        • Intervalrequired — (Integer)

          The approximate interval, in seconds, between health checks of an individual instance.

        • Timeoutrequired — (Integer)

          The amount of time, in seconds, during which no response means a failed health check.

          This value must be less than the Interval value.

        • UnhealthyThresholdrequired — (Integer)

          The number of consecutive health check failures required before moving the instance to the Unhealthy state.

        • HealthyThresholdrequired — (Integer)

          The number of consecutive health checks successes required before moving the instance to the Healthy state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAppCookieStickinessPolicy(params = {}, callback) ⇒ AWS.Request

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

Service Reference:

Examples:

To generate a stickiness policy for your load balancer


/* This example generates a stickiness policy that follows the sticky session lifetimes of the application-generated cookie. */

 var params = {
  CookieName: "my-app-cookie", 
  LoadBalancerName: "my-load-balancer", 
  PolicyName: "my-app-cookie-policy"
 };
 elb.createAppCookieStickinessPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createAppCookieStickinessPolicy operation

var params = {
  CookieName: 'STRING_VALUE', /* required */
  LoadBalancerName: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE' /* required */
};
elb.createAppCookieStickinessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • PolicyName — (String)

      The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

    • CookieName — (String)

      The name of the application cookie used for stickiness.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLBCookieStickinessPolicy(params = {}, callback) ⇒ AWS.Request

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.

Service Reference:

Examples:

To generate a duration-based stickiness policy for your load balancer


/* This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period. */

 var params = {
  CookieExpirationPeriod: 60, 
  LoadBalancerName: "my-load-balancer", 
  PolicyName: "my-duration-cookie-policy"
 };
 elb.createLBCookieStickinessPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createLBCookieStickinessPolicy operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE', /* required */
  CookieExpirationPeriod: 'NUMBER_VALUE'
};
elb.createLBCookieStickinessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • PolicyName — (String)

      The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

    • CookieExpirationPeriod — (Integer)

      The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLoadBalancer(params = {}, callback) ⇒ AWS.Request

Creates a Classic Load Balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.

Service Reference:

Examples:

To create an HTTP load balancer in a VPC


/* This example creates a load balancer with an HTTP listener in a VPC. */

 var params = {
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }
  ], 
  LoadBalancerName: "my-load-balancer", 
  SecurityGroups: [
     "sg-a61988c3"
  ], 
  Subnets: [
     "subnet-15aaab61"
  ]
 };
 elb.createLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DNSName: "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com"
   }
   */
 });

To create an HTTP load balancer in EC2-Classic


/* This example creates a load balancer with an HTTP listener in EC2-Classic. */

 var params = {
  AvailabilityZones: [
     "us-west-2a"
  ], 
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.createLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DNSName: "my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
   }
   */
 });

To create an HTTPS load balancer in a VPC


/* This example creates a load balancer with an HTTPS listener in a VPC. */

 var params = {
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }, 
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 443, 
    Protocol: "HTTPS", 
    SSLCertificateId: "arn:aws:iam::123456789012:server-certificate/my-server-cert"
   }
  ], 
  LoadBalancerName: "my-load-balancer", 
  SecurityGroups: [
     "sg-a61988c3"
  ], 
  Subnets: [
     "subnet-15aaab61"
  ]
 };
 elb.createLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DNSName: "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com"
   }
   */
 });

To create an HTTPS load balancer in EC2-Classic


/* This example creates a load balancer with an HTTPS listener in EC2-Classic. */

 var params = {
  AvailabilityZones: [
     "us-west-2a"
  ], 
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }, 
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 443, 
    Protocol: "HTTPS", 
    SSLCertificateId: "arn:aws:iam::123456789012:server-certificate/my-server-cert"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.createLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DNSName: "my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
   }
   */
 });

To create an internal load balancer


/* This example creates an internal load balancer with an HTTP listener in a VPC. */

 var params = {
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }
  ], 
  LoadBalancerName: "my-load-balancer", 
  Scheme: "internal", 
  SecurityGroups: [
     "sg-a61988c3"
  ], 
  Subnets: [
     "subnet-15aaab61"
  ]
 };
 elb.createLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DNSName: "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
   }
   */
 });

Calling the createLoadBalancer operation

var params = {
  Listeners: [ /* required */
    {
      InstancePort: 'NUMBER_VALUE', /* required */
      LoadBalancerPort: 'NUMBER_VALUE', /* required */
      Protocol: 'STRING_VALUE', /* required */
      InstanceProtocol: 'STRING_VALUE',
      SSLCertificateId: 'STRING_VALUE'
    },
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  Scheme: 'STRING_VALUE',
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  Subnets: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elb.createLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

      This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

    • Listeners — (Array<map>)

      The listeners.

      For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

      • Protocolrequired — (String)

        The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

      • LoadBalancerPortrequired — (Integer)

        The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

      • InstanceProtocol — (String)

        The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

        If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

        If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

        If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

      • InstancePortrequired — (Integer)

        The port on which the instance is listening.

      • SSLCertificateId — (String)

        The Amazon Resource Name (ARN) of the server certificate.

    • AvailabilityZones — (Array<String>)

      One or more Availability Zones from the same region as the load balancer.

      You must specify at least one Availability Zone.

      You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

    • Subnets — (Array<String>)

      The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

    • SecurityGroups — (Array<String>)

      The IDs of the security groups to assign to the load balancer.

    • Scheme — (String)

      The type of a load balancer. Valid only for load balancers in a VPC.

      By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

      Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

    • Tags — (Array<map>)

      A list of tags to assign to the load balancer.

      For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

      • Keyrequired — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DNSName — (String)

        The DNS name of the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLoadBalancerListeners(params = {}, callback) ⇒ AWS.Request

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

Service Reference:

Examples:

To create an HTTP listener for a load balancer


/* This example creates a listener for your load balancer at port 80 using the HTTP protocol. */

 var params = {
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 80, 
    Protocol: "HTTP"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.createLoadBalancerListeners(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To create an HTTPS listener for a load balancer


/* This example creates a listener for your load balancer at port 443 using the HTTPS protocol. */

 var params = {
  Listeners: [
     {
    InstancePort: 80, 
    InstanceProtocol: "HTTP", 
    LoadBalancerPort: 443, 
    Protocol: "HTTPS", 
    SSLCertificateId: "arn:aws:iam::123456789012:server-certificate/my-server-cert"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.createLoadBalancerListeners(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createLoadBalancerListeners operation

var params = {
  Listeners: [ /* required */
    {
      InstancePort: 'NUMBER_VALUE', /* required */
      LoadBalancerPort: 'NUMBER_VALUE', /* required */
      Protocol: 'STRING_VALUE', /* required */
      InstanceProtocol: 'STRING_VALUE',
      SSLCertificateId: 'STRING_VALUE'
    },
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.createLoadBalancerListeners(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Listeners — (Array<map>)

      The listeners.

      • Protocolrequired — (String)

        The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

      • LoadBalancerPortrequired — (Integer)

        The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

      • InstanceProtocol — (String)

        The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

        If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

        If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

        If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

      • InstancePortrequired — (Integer)

        The port on which the instance is listening.

      • SSLCertificateId — (String)

        The Amazon Resource Name (ARN) of the server certificate.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLoadBalancerPolicy(params = {}, callback) ⇒ AWS.Request

Creates a policy with the specified attributes for the specified load balancer.

Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.

Service Reference:

Examples:

To create a policy that enables Proxy Protocol on a load balancer


/* This example creates a policy that enables Proxy Protocol on the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  PolicyAttributes: [
     {
    AttributeName: "ProxyProtocol", 
    AttributeValue: "true"
   }
  ], 
  PolicyName: "my-ProxyProtocol-policy", 
  PolicyTypeName: "ProxyProtocolPolicyType"
 };
 elb.createLoadBalancerPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To create a public key policy


/* This example creates a public key policy. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  PolicyAttributes: [
     {
    AttributeName: "PublicKey", 
    AttributeValue: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE"
   }
  ], 
  PolicyName: "my-PublicKey-policy", 
  PolicyTypeName: "PublicKeyPolicyType"
 };
 elb.createLoadBalancerPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

To create a backend server authentication policy


/* This example creates a backend server authentication policy that enables authentication on your backend instance using a public key policy. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  PolicyAttributes: [
     {
    AttributeName: "PublicKeyPolicyName", 
    AttributeValue: "my-PublicKey-policy"
   }
  ], 
  PolicyName: "my-authentication-policy", 
  PolicyTypeName: "BackendServerAuthenticationPolicyType"
 };
 elb.createLoadBalancerPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the createLoadBalancerPolicy operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE', /* required */
  PolicyTypeName: 'STRING_VALUE', /* required */
  PolicyAttributes: [
    {
      AttributeName: 'STRING_VALUE',
      AttributeValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elb.createLoadBalancerPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • PolicyName — (String)

      The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.

    • PolicyTypeName — (String)

      The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

    • PolicyAttributes — (Array<map>)

      The policy attributes.

      • AttributeName — (String)

        The name of the attribute.

      • AttributeValue — (String)

        The value of the attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLoadBalancer(params = {}, callback) ⇒ AWS.Request

Deletes the specified load balancer.

If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.

If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.

Service Reference:

Examples:

To delete a load balancer


/* This example deletes the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer"
 };
 elb.deleteLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteLoadBalancer operation

var params = {
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.deleteLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLoadBalancerListeners(params = {}, callback) ⇒ AWS.Request

Deletes the specified listeners from the specified load balancer.

Service Reference:

Examples:

To delete a listener from your load balancer


/* This example deletes the listener for the specified port from the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  LoadBalancerPorts: [
     80
  ]
 };
 elb.deleteLoadBalancerListeners(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteLoadBalancerListeners operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  LoadBalancerPorts: [ /* required */
    'NUMBER_VALUE',
    /* more items */
  ]
};
elb.deleteLoadBalancerListeners(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • LoadBalancerPorts — (Array<Integer>)

      The client port numbers of the listeners.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLoadBalancerPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

Service Reference:

Examples:

To delete a policy from your load balancer


/* This example deletes the specified policy from the specified load balancer. The policy must not be enabled on any listener. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  PolicyName: "my-duration-cookie-policy"
 };
 elb.deleteLoadBalancerPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteLoadBalancerPolicy operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE' /* required */
};
elb.deleteLoadBalancerPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • PolicyName — (String)

      The name of the policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterInstancesFromLoadBalancer(params = {}, callback) ⇒ AWS.Request

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

Examples:

To deregister instances from a load balancer


/* This example deregisters the specified instance from the specified load balancer. */

 var params = {
  Instances: [
     {
    InstanceId: "i-d6f6fae3"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.deregisterInstancesFromLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Instances: [
       {
      InstanceId: "i-207d9717"
     }, 
       {
      InstanceId: "i-afefb49b"
     }
    ]
   }
   */
 });

Calling the deregisterInstancesFromLoadBalancer operation

var params = {
  Instances: [ /* required */
    {
      InstanceId: 'STRING_VALUE'
    },
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.deregisterInstancesFromLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        The remaining instances registered with the load balancer.

        • InstanceId — (String)

          The instance ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccountLimits(params = {}, callback) ⇒ AWS.Request

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.

Service Reference:

Examples:

Calling the describeAccountLimits operation

var params = {
  Marker: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
elb.describeAccountLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Marker — (String)

      The marker for the next set of results. (You received this marker from a previous call.)

    • PageSize — (Integer)

      The maximum number of results to return with this call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Limits — (Array<map>)

        Information about the limits.

        • Name — (String)

          The name of the limit. The possible values are:

          • classic-listeners

          • classic-load-balancers

          • classic-registered-instances

        • Max — (String)

          The maximum value of the limit.

      • NextMarker — (String)

        The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeInstanceHealth(params = {}, callback) ⇒ AWS.Request

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

Service Reference:

Examples:

To describe the health of the instances for a load balancer


/* This example describes the health of the instances for the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer"
 };
 elb.describeInstanceHealth(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceStates: [
       {
      Description: "N/A", 
      InstanceId: "i-207d9717", 
      ReasonCode: "N/A", 
      State: "InService"
     }, 
       {
      Description: "N/A", 
      InstanceId: "i-afefb49b", 
      ReasonCode: "N/A", 
      State: "InService"
     }
    ]
   }
   */
 });

Calling the describeInstanceHealth operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  Instances: [
    {
      InstanceId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elb.describeInstanceHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceStates — (Array<map>)

        Information about the health of the instances.

        • InstanceId — (String)

          The ID of the instance.

        • State — (String)

          The current state of the instance.

          Valid values: InService | OutOfService | Unknown

        • ReasonCode — (String)

          Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

          Valid values: ELB | Instance | N/A

        • Description — (String)

          A description of the instance state. This string can contain one or more of the following messages.

          • N/A

          • A transient error occurred. Please try again later.

          • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

          • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

          • Instance registration is still in progress.

          • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

          • Instance is not currently registered with the LoadBalancer.

          • Instance deregistration currently in progress.

          • Disable Availability Zone is currently in progress.

          • Instance is in pending state.

          • Instance is in stopped state.

          • Instance is in terminated state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeLoadBalancerAttributes(params = {}, callback) ⇒ AWS.Request

Describes the attributes for the specified load balancer.

Service Reference:

Examples:

To describe the attributes of a load balancer


/* This example describes the attributes of the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer"
 };
 elb.describeLoadBalancerAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LoadBalancerAttributes: {
     AccessLog: {
      Enabled: false
     }, 
     ConnectionDraining: {
      Enabled: false, 
      Timeout: 300
     }, 
     ConnectionSettings: {
      IdleTimeout: 60
     }, 
     CrossZoneLoadBalancing: {
      Enabled: false
     }
    }
   }
   */
 });

Calling the describeLoadBalancerAttributes operation

var params = {
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.describeLoadBalancerAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoadBalancerAttributes — (map)

        Information about the load balancer attributes.

        • CrossZoneLoadBalancing — (map)

          If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

          For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether cross-zone load balancing is enabled for the load balancer.

        • AccessLog — (map)

          If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

          For more information, see Enable Access Logs in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether access logs are enabled for the load balancer.

          • S3BucketName — (String)

            The name of the Amazon S3 bucket where the access logs are stored.

          • EmitInterval — (Integer)

            The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

            Default: 60 minutes

          • S3BucketPrefix — (String)

            The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

        • ConnectionDraining — (map)

          If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

          For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether connection draining is enabled for the load balancer.

          • Timeout — (Integer)

            The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

        • ConnectionSettings — (map)

          If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

          By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

          • IdleTimeoutrequired — (Integer)

            The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

        • AdditionalAttributes — (Array<map>)

          Any additional attributes.

          • Key — (String)

            The name of the attribute.

            The following attribute is supported.

            • elb.http.desyncmitigationmode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.

          • Value — (String)

            This value of the attribute.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLoadBalancerPolicies(params = {}, callback) ⇒ AWS.Request

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.

Service Reference:

Examples:

To describe a policy associated with a load balancer


/* This example describes the specified policy associated with the specified load balancer. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  PolicyNames: [
     "my-authentication-policy"
  ]
 };
 elb.describeLoadBalancerPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyDescriptions: [
       {
      PolicyAttributeDescriptions: [
         {
        AttributeName: "PublicKeyPolicyName", 
        AttributeValue: "my-PublicKey-policy"
       }
      ], 
      PolicyName: "my-authentication-policy", 
      PolicyTypeName: "BackendServerAuthenticationPolicyType"
     }
    ]
   }
   */
 });

Calling the describeLoadBalancerPolicies operation

var params = {
  LoadBalancerName: 'STRING_VALUE',
  PolicyNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
elb.describeLoadBalancerPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • PolicyNames — (Array<String>)

      The names of the policies.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyDescriptions — (Array<map>)

        Information about the policies.

        • PolicyName — (String)

          The name of the policy.

        • PolicyTypeName — (String)

          The name of the policy type.

        • PolicyAttributeDescriptions — (Array<map>)

          The policy attributes.

          • AttributeName — (String)

            The name of the attribute.

          • AttributeValue — (String)

            The value of the attribute.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLoadBalancerPolicyTypes(params = {}, callback) ⇒ AWS.Request

Describes the specified load balancer policy types or all load balancer policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

Service Reference:

Examples:

To describe a load balancer policy type defined by Elastic Load Balancing


/* This example describes the specified load balancer policy type. */

 var params = {
  PolicyTypeNames: [
     "ProxyProtocolPolicyType"
  ]
 };
 elb.describeLoadBalancerPolicyTypes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyTypeDescriptions: [
       {
      Description: "Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP listeners only.", 
      PolicyAttributeTypeDescriptions: [
         {
        AttributeName: "ProxyProtocol", 
        AttributeType: "Boolean", 
        Cardinality: "ONE"
       }
      ], 
      PolicyTypeName: "ProxyProtocolPolicyType"
     }
    ]
   }
   */
 });

Calling the describeLoadBalancerPolicyTypes operation

var params = {
  PolicyTypeNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
elb.describeLoadBalancerPolicyTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyTypeNames — (Array<String>)

      The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyTypeDescriptions — (Array<map>)

        Information about the policy types.

        • PolicyTypeName — (String)

          The name of the policy type.

        • Description — (String)

          A description of the policy type.

        • PolicyAttributeTypeDescriptions — (Array<map>)

          The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

          • AttributeName — (String)

            The name of the attribute.

          • AttributeType — (String)

            The type of the attribute. For example, Boolean or Integer.

          • Description — (String)

            A description of the attribute.

          • DefaultValue — (String)

            The default value of the attribute, if applicable.

          • Cardinality — (String)

            The cardinality of the attribute.

            Valid values:

            • ONE(1) : Single value required

            • ZERO_OR_ONE(0..1) : Up to one value is allowed

            • ZERO_OR_MORE(0..) : Optional. Multiple values are allowed

            • ONE_OR_MORE(1..0) : Required. Multiple values are allowed

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLoadBalancers(params = {}, callback) ⇒ AWS.Request

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

Service Reference:

Examples:

To describe one of your load balancers


/* This example describes the specified load balancer. */

 var params = {
  LoadBalancerNames: [
     "my-load-balancer"
  ]
 };
 elb.describeLoadBalancers(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LoadBalancerDescriptions: [
       {
      AvailabilityZones: [
         "us-west-2a"
      ], 
      BackendServerDescriptions: [
         {
        InstancePort: 80, 
        PolicyNames: [
           "my-ProxyProtocol-policy"
        ]
       }
      ], 
      CanonicalHostedZoneName: "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", 
      CanonicalHostedZoneNameID: "Z3DZXE0EXAMPLE", 
      CreatedTime: <Date Representation>, 
      DNSName: "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", 
      HealthCheck: {
       HealthyThreshold: 2, 
       Interval: 30, 
       Target: "HTTP:80/png", 
       Timeout: 3, 
       UnhealthyThreshold: 2
      }, 
      Instances: [
         {
        InstanceId: "i-207d9717"
       }, 
         {
        InstanceId: "i-afefb49b"
       }
      ], 
      ListenerDescriptions: [
         {
        Listener: {
         InstancePort: 80, 
         InstanceProtocol: "HTTP", 
         LoadBalancerPort: 80, 
         Protocol: "HTTP"
        }, 
        PolicyNames: [
        ]
       }, 
         {
        Listener: {
         InstancePort: 443, 
         InstanceProtocol: "HTTPS", 
         LoadBalancerPort: 443, 
         Protocol: "HTTPS", 
         SSLCertificateId: "arn:aws:iam::123456789012:server-certificate/my-server-cert"
        }, 
        PolicyNames: [
           "ELBSecurityPolicy-2015-03"
        ]
       }
      ], 
      LoadBalancerName: "my-load-balancer", 
      Policies: {
       AppCookieStickinessPolicies: [
       ], 
       LBCookieStickinessPolicies: [
          {
         CookieExpirationPeriod: 60, 
         PolicyName: "my-duration-cookie-policy"
        }
       ], 
       OtherPolicies: [
          "my-PublicKey-policy", 
          "my-authentication-policy", 
          "my-SSLNegotiation-policy", 
          "my-ProxyProtocol-policy", 
          "ELBSecurityPolicy-2015-03"
       ]
      }, 
      Scheme: "internet-facing", 
      SecurityGroups: [
         "sg-a61988c3"
      ], 
      SourceSecurityGroup: {
       GroupName: "my-elb-sg", 
       OwnerAlias: "123456789012"
      }, 
      Subnets: [
         "subnet-15aaab61"
      ], 
      VPCId: "vpc-a01106c2"
     }
    ]
   }
   */
 });

Calling the describeLoadBalancers operation

var params = {
  LoadBalancerNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
elb.describeLoadBalancers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerNames — (Array<String>)

      The names of the load balancers.

    • Marker — (String)

      The marker for the next set of results. (You received this marker from a previous call.)

    • PageSize — (Integer)

      The maximum number of results to return with this call (a number from 1 to 400). The default is 400.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoadBalancerDescriptions — (Array<map>)

        Information about the load balancers.

        • LoadBalancerName — (String)

          The name of the load balancer.

        • DNSName — (String)

          The DNS name of the load balancer.

        • CanonicalHostedZoneName — (String)

          The DNS name of the load balancer.

          For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.

        • CanonicalHostedZoneNameID — (String)

          The ID of the Amazon Route 53 hosted zone for the load balancer.

        • ListenerDescriptions — (Array<map>)

          The listeners for the load balancer.

          • Listener — (map)

            The listener.

            • Protocolrequired — (String)

              The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

            • LoadBalancerPortrequired — (Integer)

              The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

            • InstanceProtocol — (String)

              The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

              If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

              If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

              If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

            • InstancePortrequired — (Integer)

              The port on which the instance is listening.

            • SSLCertificateId — (String)

              The Amazon Resource Name (ARN) of the server certificate.

          • PolicyNames — (Array<String>)

            The policies. If there are no policies enabled, the list is empty.

        • Policies — (map)

          The policies defined for the load balancer.

          • AppCookieStickinessPolicies — (Array<map>)

            The stickiness policies created using CreateAppCookieStickinessPolicy.

            • PolicyName — (String)

              The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

            • CookieName — (String)

              The name of the application cookie used for stickiness.

          • LBCookieStickinessPolicies — (Array<map>)

            The stickiness policies created using CreateLBCookieStickinessPolicy.

            • PolicyName — (String)

              The name of the policy. This name must be unique within the set of policies for this load balancer.

            • CookieExpirationPeriod — (Integer)

              The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.

          • OtherPolicies — (Array<String>)

            The policies other than the stickiness policies.

        • BackendServerDescriptions — (Array<map>)

          Information about your EC2 instances.

          • InstancePort — (Integer)

            The port on which the EC2 instance is listening.

          • PolicyNames — (Array<String>)

            The names of the policies enabled for the EC2 instance.

        • AvailabilityZones — (Array<String>)

          The Availability Zones for the load balancer.

        • Subnets — (Array<String>)

          The IDs of the subnets for the load balancer.

        • VPCId — (String)

          The ID of the VPC for the load balancer.

        • Instances — (Array<map>)

          The IDs of the instances for the load balancer.

          • InstanceId — (String)

            The instance ID.

        • HealthCheck — (map)

          Information about the health checks conducted on the load balancer.

          • Targetrequired — (String)

            The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

            TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

            SSL is also specified as SSL: port pair, for example, SSL:5000.

            For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

            The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

          • Intervalrequired — (Integer)

            The approximate interval, in seconds, between health checks of an individual instance.

          • Timeoutrequired — (Integer)

            The amount of time, in seconds, during which no response means a failed health check.

            This value must be less than the Interval value.

          • UnhealthyThresholdrequired — (Integer)

            The number of consecutive health check failures required before moving the instance to the Unhealthy state.

          • HealthyThresholdrequired — (Integer)

            The number of consecutive health checks successes required before moving the instance to the Healthy state.

        • SourceSecurityGroup — (map)

          The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

          • OwnerAlias — (String)

            The owner of the security group.

          • GroupName — (String)

            The name of the security group.

        • SecurityGroups — (Array<String>)

          The security groups for the load balancer. Valid only for load balancers in a VPC.

        • CreatedTime — (Date)

          The date and time the load balancer was created.

        • Scheme — (String)

          The type of load balancer. Valid only for load balancers in a VPC.

          If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

          If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

      • NextMarker — (String)

        The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTags(params = {}, callback) ⇒ AWS.Request

Describes the tags associated with the specified load balancers.

Service Reference:

Examples:

To describe the tags for a load balancer


/* This example describes the tags for the specified load balancer. */

 var params = {
  LoadBalancerNames: [
     "my-load-balancer"
  ]
 };
 elb.describeTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TagDescriptions: [
       {
      LoadBalancerName: "my-load-balancer", 
      Tags: [
         {
        Key: "project", 
        Value: "lima"
       }, 
         {
        Key: "department", 
        Value: "digital-media"
       }
      ]
     }
    ]
   }
   */
 });

Calling the describeTags operation

var params = {
  LoadBalancerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.describeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerNames — (Array<String>)

      The names of the load balancers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagDescriptions — (Array<map>)

        Information about the tags.

        • LoadBalancerName — (String)

          The name of the load balancer.

        • Tags — (Array<map>)

          The tags.

          • Keyrequired — (String)

            The key of the tag.

          • Value — (String)

            The value of the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detachLoadBalancerFromSubnets(params = {}, callback) ⇒ AWS.Request

Removes the specified subnets from the set of configured subnets for the load balancer.

After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.

Service Reference:

Examples:

To detach a load balancer from a subnet


/* This example detaches the specified load balancer from the specified subnet. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  Subnets: [
     "subnet-0ecac448"
  ]
 };
 elb.detachLoadBalancerFromSubnets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Subnets: [
       "subnet-15aaab61"
    ]
   }
   */
 });

Calling the detachLoadBalancerFromSubnets operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  Subnets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.detachLoadBalancerFromSubnets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Subnets — (Array<String>)

      The IDs of the subnets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subnets — (Array<String>)

        The IDs of the remaining subnets for the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableAvailabilityZonesForLoadBalancer(params = {}, callback) ⇒ AWS.Request

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

Examples:

To disable an Availability Zone for a load balancer


/* This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer. */

 var params = {
  AvailabilityZones: [
     "us-west-2a"
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.disableAvailabilityZonesForLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AvailabilityZones: [
       "us-west-2b"
    ]
   }
   */
 });

Calling the disableAvailabilityZonesForLoadBalancer operation

var params = {
  AvailabilityZones: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.disableAvailabilityZonesForLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • AvailabilityZones — (Array<String>)

      The Availability Zones.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AvailabilityZones — (Array<String>)

        The remaining Availability Zones for the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableAvailabilityZonesForLoadBalancer(params = {}, callback) ⇒ AWS.Request

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

Examples:

To enable an Availability Zone for a load balancer


/* This example adds the specified Availability Zone to the specified load balancer. */

 var params = {
  AvailabilityZones: [
     "us-west-2b"
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.enableAvailabilityZonesForLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AvailabilityZones: [
       "us-west-2a", 
       "us-west-2b"
    ]
   }
   */
 });

Calling the enableAvailabilityZonesForLoadBalancer operation

var params = {
  AvailabilityZones: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.enableAvailabilityZonesForLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • AvailabilityZones — (Array<String>)

      The Availability Zones. These must be in the same region as the load balancer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AvailabilityZones — (Array<String>)

        The updated list of Availability Zones for the load balancer.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

modifyLoadBalancerAttributes(params = {}, callback) ⇒ AWS.Request

Modifies the attributes of the specified load balancer.

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following in the Classic Load Balancers Guide:

Service Reference:

Examples:

To enable cross-zone load balancing


/* This example enables cross-zone load balancing for the specified load balancer. */

 var params = {
  LoadBalancerAttributes: {
   CrossZoneLoadBalancing: {
    Enabled: true
   }
  }, 
  LoadBalancerName: "my-load-balancer"
 };
 elb.modifyLoadBalancerAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LoadBalancerAttributes: {
     CrossZoneLoadBalancing: {
      Enabled: true
     }
    }, 
    LoadBalancerName: "my-load-balancer"
   }
   */
 });

To enable connection draining


/* This example enables connection draining for the specified load balancer. */

 var params = {
  LoadBalancerAttributes: {
   ConnectionDraining: {
    Enabled: true, 
    Timeout: 300
   }
  }, 
  LoadBalancerName: "my-load-balancer"
 };
 elb.modifyLoadBalancerAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LoadBalancerAttributes: {
     ConnectionDraining: {
      Enabled: true, 
      Timeout: 300
     }
    }, 
    LoadBalancerName: "my-load-balancer"
   }
   */
 });

Calling the modifyLoadBalancerAttributes operation

var params = {
  LoadBalancerAttributes: { /* required */
    AccessLog: {
      Enabled: true || false, /* required */
      EmitInterval: 'NUMBER_VALUE',
      S3BucketName: 'STRING_VALUE',
      S3BucketPrefix: 'STRING_VALUE'
    },
    AdditionalAttributes: [
      {
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ConnectionDraining: {
      Enabled: true || false, /* required */
      Timeout: 'NUMBER_VALUE'
    },
    ConnectionSettings: {
      IdleTimeout: 'NUMBER_VALUE' /* required */
    },
    CrossZoneLoadBalancing: {
      Enabled: true || false /* required */
    }
  },
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.modifyLoadBalancerAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • LoadBalancerAttributes — (map)

      The attributes for the load balancer.

      • CrossZoneLoadBalancing — (map)

        If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

        For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

        • Enabledrequired — (Boolean)

          Specifies whether cross-zone load balancing is enabled for the load balancer.

      • AccessLog — (map)

        If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

        For more information, see Enable Access Logs in the Classic Load Balancers Guide.

        • Enabledrequired — (Boolean)

          Specifies whether access logs are enabled for the load balancer.

        • S3BucketName — (String)

          The name of the Amazon S3 bucket where the access logs are stored.

        • EmitInterval — (Integer)

          The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

          Default: 60 minutes

        • S3BucketPrefix — (String)

          The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

      • ConnectionDraining — (map)

        If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

        For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

        • Enabledrequired — (Boolean)

          Specifies whether connection draining is enabled for the load balancer.

        • Timeout — (Integer)

          The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

      • ConnectionSettings — (map)

        If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

        By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

        • IdleTimeoutrequired — (Integer)

          The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

      • AdditionalAttributes — (Array<map>)

        Any additional attributes.

        • Key — (String)

          The name of the attribute.

          The following attribute is supported.

          • elb.http.desyncmitigationmode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.

        • Value — (String)

          This value of the attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoadBalancerName — (String)

        The name of the load balancer.

      • LoadBalancerAttributes — (map)

        Information about the load balancer attributes.

        • CrossZoneLoadBalancing — (map)

          If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

          For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether cross-zone load balancing is enabled for the load balancer.

        • AccessLog — (map)

          If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

          For more information, see Enable Access Logs in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether access logs are enabled for the load balancer.

          • S3BucketName — (String)

            The name of the Amazon S3 bucket where the access logs are stored.

          • EmitInterval — (Integer)

            The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

            Default: 60 minutes

          • S3BucketPrefix — (String)

            The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

        • ConnectionDraining — (map)

          If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

          For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

          • Enabledrequired — (Boolean)

            Specifies whether connection draining is enabled for the load balancer.

          • Timeout — (Integer)

            The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

        • ConnectionSettings — (map)

          If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

          By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

          • IdleTimeoutrequired — (Integer)

            The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

        • AdditionalAttributes — (Array<map>)

          Any additional attributes.

          • Key — (String)

            The name of the attribute.

            The following attribute is supported.

            • elb.http.desyncmitigationmode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.

          • Value — (String)

            This value of the attribute.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerInstancesWithLoadBalancer(params = {}, callback) ⇒ AWS.Request

Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

Examples:

To register instances with a load balancer


/* This example registers the specified instance with the specified load balancer. */

 var params = {
  Instances: [
     {
    InstanceId: "i-d6f6fae3"
   }
  ], 
  LoadBalancerName: "my-load-balancer"
 };
 elb.registerInstancesWithLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Instances: [
       {
      InstanceId: "i-d6f6fae3"
     }, 
       {
      InstanceId: "i-207d9717"
     }, 
       {
      InstanceId: "i-afefb49b"
     }
    ]
   }
   */
 });

Calling the registerInstancesWithLoadBalancer operation

var params = {
  Instances: [ /* required */
    {
      InstanceId: 'STRING_VALUE'
    },
    /* more items */
  ],
  LoadBalancerName: 'STRING_VALUE' /* required */
};
elb.registerInstancesWithLoadBalancer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        The updated list of instances for the load balancer.

        • InstanceId — (String)

          The instance ID.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeTags(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified load balancer.

Service Reference:

Examples:

To remove tags from a load balancer


/* This example removes the specified tag from the specified load balancer. */

 var params = {
  LoadBalancerNames: [
     "my-load-balancer"
  ], 
  Tags: [
     {
    Key: "project"
   }
  ]
 };
 elb.removeTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the removeTags operation

var params = {
  LoadBalancerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elb.removeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerNames — (Array<String>)

      The name of the load balancer. You can specify a maximum of one load balancer name.

    • Tags — (Array<map>)

      The list of tag keys to remove.

      • Key — (String)

        The name of the key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

setLoadBalancerListenerSSLCertificate(params = {}, callback) ⇒ AWS.Request

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.

Examples:

To update the SSL certificate for an HTTPS listener


/* This example replaces the existing SSL certificate for the specified HTTPS listener. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  LoadBalancerPort: 443, 
  SSLCertificateId: "arn:aws:iam::123456789012:server-certificate/new-server-cert"
 };
 elb.setLoadBalancerListenerSSLCertificate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setLoadBalancerListenerSSLCertificate operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  LoadBalancerPort: 'NUMBER_VALUE', /* required */
  SSLCertificateId: 'STRING_VALUE' /* required */
};
elb.setLoadBalancerListenerSSLCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • LoadBalancerPort — (Integer)

      The port that uses the specified SSL certificate.

    • SSLCertificateId — (String)

      The Amazon Resource Name (ARN) of the SSL certificate.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

setLoadBalancerPoliciesForBackendServer(params = {}, callback) ⇒ AWS.Request

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.

Examples:

To replace the policies associated with a port for a backend instance


/* This example replaces the policies that are currently associated with the specified port. */

 var params = {
  InstancePort: 80, 
  LoadBalancerName: "my-load-balancer", 
  PolicyNames: [
     "my-ProxyProtocol-policy"
  ]
 };
 elb.setLoadBalancerPoliciesForBackendServer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setLoadBalancerPoliciesForBackendServer operation

var params = {
  InstancePort: 'NUMBER_VALUE', /* required */
  LoadBalancerName: 'STRING_VALUE', /* required */
  PolicyNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.setLoadBalancerPoliciesForBackendServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • InstancePort — (Integer)

      The port number associated with the EC2 instance.

    • PolicyNames — (Array<String>)

      The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

setLoadBalancerPoliciesOfListener(params = {}, callback) ⇒ AWS.Request

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

Examples:

To replace the policies associated with a listener


/* This example replaces the policies that are currently associated with the specified listener. */

 var params = {
  LoadBalancerName: "my-load-balancer", 
  LoadBalancerPort: 80, 
  PolicyNames: [
     "my-SSLNegotiation-policy"
  ]
 };
 elb.setLoadBalancerPoliciesOfListener(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the setLoadBalancerPoliciesOfListener operation

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
  LoadBalancerPort: 'NUMBER_VALUE', /* required */
  PolicyNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
elb.setLoadBalancerPoliciesOfListener(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoadBalancerName — (String)

      The name of the load balancer.

    • LoadBalancerPort — (Integer)

      The external port of the load balancer.

    • PolicyNames — (Array<String>)

      The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given ELB resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the instanceDeregistered state

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
};
elb.waitFor('instanceDeregistered', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

elb.waitFor('instanceDeregistered', params = {}, [callback]) ⇒ AWS.Request

Waits for the instanceDeregistered state by periodically calling the underlying ELB.describeInstanceHealth() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the instanceDeregistered state

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
};
elb.waitFor('instanceDeregistered', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceStates — (Array<map>)

        Information about the health of the instances.

        • InstanceId — (String)

          The ID of the instance.

        • State — (String)

          The current state of the instance.

          Valid values: InService | OutOfService | Unknown

        • ReasonCode — (String)

          Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

          Valid values: ELB | Instance | N/A

        • Description — (String)

          A description of the instance state. This string can contain one or more of the following messages.

          • N/A

          • A transient error occurred. Please try again later.

          • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

          • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

          • Instance registration is still in progress.

          • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

          • Instance is not currently registered with the LoadBalancer.

          • Instance deregistration currently in progress.

          • Disable Availability Zone is currently in progress.

          • Instance is in pending state.

          • Instance is in stopped state.

          • Instance is in terminated state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

elb.waitFor('anyInstanceInService', params = {}, [callback]) ⇒ AWS.Request

Waits for the anyInstanceInService state by periodically calling the underlying ELB.describeInstanceHealth() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the anyInstanceInService state

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
};
elb.waitFor('anyInstanceInService', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceStates — (Array<map>)

        Information about the health of the instances.

        • InstanceId — (String)

          The ID of the instance.

        • State — (String)

          The current state of the instance.

          Valid values: InService | OutOfService | Unknown

        • ReasonCode — (String)

          Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

          Valid values: ELB | Instance | N/A

        • Description — (String)

          A description of the instance state. This string can contain one or more of the following messages.

          • N/A

          • A transient error occurred. Please try again later.

          • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

          • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

          • Instance registration is still in progress.

          • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

          • Instance is not currently registered with the LoadBalancer.

          • Instance deregistration currently in progress.

          • Disable Availability Zone is currently in progress.

          • Instance is in pending state.

          • Instance is in stopped state.

          • Instance is in terminated state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also:

elb.waitFor('instanceInService', params = {}, [callback]) ⇒ AWS.Request

Waits for the instanceInService state by periodically calling the underlying ELB.describeInstanceHealth() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the instanceInService state

var params = {
  LoadBalancerName: 'STRING_VALUE', /* required */
};
elb.waitFor('instanceInService', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • LoadBalancerName — (String)

      The name of the load balancer.

    • Instances — (Array<map>)

      The IDs of the instances.

      • InstanceId — (String)

        The instance ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceStates — (Array<map>)

        Information about the health of the instances.

        • InstanceId — (String)

          The ID of the instance.

        • State — (String)

          The current state of the instance.

          Valid values: InService | OutOfService | Unknown

        • ReasonCode — (String)

          Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

          Valid values: ELB | Instance | N/A

        • Description — (String)

          A description of the instance state. This string can contain one or more of the following messages.

          • N/A

          • A transient error occurred. Please try again later.

          • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

          • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

          • Instance registration is still in progress.

          • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

          • Instance is not currently registered with the LoadBalancer.

          • Instance deregistration currently in progress.

          • Disable Availability Zone is currently in progress.

          • Instance is in pending state.

          • Instance is in stopped state.

          • Instance is in terminated state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also: