Class: AWS.ELB

/* 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"
    ]
   }
   */
 });

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.

/* 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"
    ]
   }
   */
 });

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.

/* 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
    }
   }
   */
 });

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.

    • Target — required — (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.

    • Interval — required — (Integer)

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

    • Timeout — required — (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.

    • UnhealthyThreshold — required — (Integer)

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

    • HealthyThreshold — required — (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.

      • Target — required — (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.

      • Interval — required — (Integer)

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

      • Timeout — required — (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.

      • UnhealthyThreshold — required — (Integer)

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

      • HealthyThreshold — required — (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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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"
   }
   */
 });

/* 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"
   }
   */
 });

/* 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"
   }
   */
 });

/* 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"
   }
   */
 });

/* 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"
   }
   */
 });

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.

    • Protocol — required — (String)

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

    • LoadBalancerPort — required — (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.

    • InstancePort — required — (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.

    • Key — required — (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.

/* 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 = {
   }
   */
 });

/* 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 = {
   }
   */
 });

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.

    • Protocol — required — (String)

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

    • LoadBalancerPort — required — (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.

    • InstancePort — required — (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.

/* 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 = {
   }
   */
 });

/* 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 = {
   }
   */
 });

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

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.

/* 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"
     }
    ]
   }
   */
 });

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:

• instanceDeregistered

• anyInstanceInService

• instanceInService

/* 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
     }
    }
   }
   */
 });

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.

        • Enabled — required — (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.

        • Enabled — required — (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.

        • Enabled — required — (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.

        • IdleTimeout — required — (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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

          • Protocol — required — (String)

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

          • LoadBalancerPort — required — (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.

          • InstancePort — required — (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.

        • Target — required — (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.

        • Interval — required — (Integer)

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

        • Timeout — required — (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.

        • UnhealthyThreshold — required — (Integer)

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

        • HealthyThreshold — required — (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.

/* 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"
       }
      ]
     }
    ]
   }
   */
 });

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.

        • Key — required — (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.

/* 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"
    ]
   }
   */
 });

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.

/* 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"
    ]
   }
   */
 });

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.

/* 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"
    ]
   }
   */
 });

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.

/* 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"
   }
   */
 });

/* 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"
   }
   */
 });

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.

      • Enabled — required — (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.

      • Enabled — required — (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.

      • Enabled — required — (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.

      • IdleTimeout — required — (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.

        • Enabled — required — (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.

        • Enabled — required — (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.

        • Enabled — required — (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.

        • IdleTimeout — required — (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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

/* 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 = {
   }
   */
 });

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.

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:

• instanceDeregistered

• anyInstanceInService

• instanceInService