Class: AWS.ELBv2

/* This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration. */

 var params = {
  Name: "my-targets", 
  Port: 80, 
  Protocol: "HTTP", 
  VpcId: "vpc-3ac0fb5f"
 };
 elbv2.createTargetGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TargetGroups: [
       {
      HealthCheckIntervalSeconds: 30, 
      HealthCheckPath: "/", 
      HealthCheckPort: "traffic-port", 
      HealthCheckProtocol: "HTTP", 
      HealthCheckTimeoutSeconds: 5, 
      HealthyThresholdCount: 5, 
      Matcher: {
       HttpCode: "200"
      }, 
      Port: 80, 
      Protocol: "HTTP", 
      TargetGroupArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
      TargetGroupName: "my-targets", 
      UnhealthyThresholdCount: 2, 
      VpcId: "vpc-3ac0fb5f"
     }
    ]
   }
   */
 });

var params = {
  Name: 'STRING_VALUE', /* required */
  HealthCheckEnabled: true || false,
  HealthCheckIntervalSeconds: 'NUMBER_VALUE',
  HealthCheckPath: 'STRING_VALUE',
  HealthCheckPort: 'STRING_VALUE',
  HealthCheckProtocol: HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP | GENEVE,
  HealthCheckTimeoutSeconds: 'NUMBER_VALUE',
  HealthyThresholdCount: 'NUMBER_VALUE',
  IpAddressType: ipv4 | ipv6,
  Matcher: {
    GrpcCode: 'STRING_VALUE',
    HttpCode: 'STRING_VALUE'
  },
  Port: 'NUMBER_VALUE',
  Protocol: HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP | GENEVE,
  ProtocolVersion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetType: instance | ip | lambda | alb,
  UnhealthyThresholdCount: 'NUMBER_VALUE',
  VpcId: 'STRING_VALUE'
};
elbv2.createTargetGroup(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: {}) —
  • Name — (String)

    The name of the target group.

    This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

  • Protocol — (String)

    The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

    Possible values include:
    • "HTTP"
    • "HTTPS"
    • "TCP"
    • "TLS"
    • "UDP"
    • "TCP_UDP"
    • "GENEVE"
  • ProtocolVersion — (String)

    [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

  • Port — (Integer)

    The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

  • VpcId — (String)

    The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

  • HealthCheckProtocol — (String)

    The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

    Possible values include:
    • "HTTP"
    • "HTTPS"
    • "TCP"
    • "TLS"
    • "UDP"
    • "TCP_UDP"
    • "GENEVE"
  • HealthCheckPort — (String)

    The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

  • HealthCheckEnabled — (Boolean)

    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.

  • HealthCheckPath — (String)

    [HTTP/HTTPS health checks] The destination for health checks on the targets.

    [HTTP1 or HTTP2 protocol version] The ping path. The default is /.

    [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

  • HealthCheckIntervalSeconds — (Integer)

    The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.

  • HealthCheckTimeoutSeconds — (Integer)

    The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.

  • HealthyThresholdCount — (Integer)

    The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda, the default is 5.

  • UnhealthyThresholdCount — (Integer)

    The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda, the default is 5.

  • Matcher — (map)

    [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

    • HttpCode — (String)

      For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

      For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

      For Gateway Load Balancers, this must be "200–399".

      Note that when using shorthand syntax, some values such as commas need to be escaped.

    • GrpcCode — (String)

      You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.

  • TargetType — (String)

    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.

    • instance - Register targets by instance ID. This is the default value.

    • ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.

    • lambda - Register a single Lambda function as a target.

    • alb - Register a single Application Load Balancer as a target.

    Possible values include:
    • "instance"
    • "ip"
    • "lambda"
    • "alb"
  • Tags — (Array<map>)

    The tags to assign to the target group.

    • Key — required — (String)

      The key of the tag.

    • Value — (String)

      The value of the tag.

  • IpAddressType — (String)

    The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

    Possible values include:
    • "ipv4"
    • "ipv6"

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:

    • TargetGroups — (Array<map>)

      Information about the target group.

      • TargetGroupArn — (String)

        The Amazon Resource Name (ARN) of the target group.

      • TargetGroupName — (String)

        The name of the target group.

      • Protocol — (String)

        The protocol to use for routing traffic to the targets.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
        • "TLS"
        • "UDP"
        • "TCP_UDP"
        • "GENEVE"
      • Port — (Integer)

        The port on which the targets are listening. This parameter is not used if the target is a Lambda function.

      • VpcId — (String)

        The ID of the VPC for the targets.

      • HealthCheckProtocol — (String)

        The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
        • "TLS"
        • "UDP"
        • "TCP_UDP"
        • "GENEVE"
      • HealthCheckPort — (String)

        The port to use to connect with the target.

      • HealthCheckEnabled — (Boolean)

        Indicates whether health checks are enabled.

      • HealthCheckIntervalSeconds — (Integer)

        The approximate amount of time, in seconds, between health checks of an individual target.

      • HealthCheckTimeoutSeconds — (Integer)

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

      • HealthyThresholdCount — (Integer)

        The number of consecutive health checks successes required before considering an unhealthy target healthy.

      • UnhealthyThresholdCount — (Integer)

        The number of consecutive health check failures required before considering the target unhealthy.

      • HealthCheckPath — (String)

        The destination for health checks on the targets.

      • Matcher — (map)

        The HTTP or gRPC codes to use when checking for a successful response from a target.

        • HttpCode — (String)

          For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

          For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

          For Gateway Load Balancers, this must be "200–399".

          Note that when using shorthand syntax, some values such as commas need to be escaped.

        • GrpcCode — (String)

          You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.

      • LoadBalancerArns — (Array<String>)

        The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.

      • TargetType — (String)

        The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

        Possible values include:
        • "instance"
        • "ip"
        • "lambda"
        • "alb"
      • ProtocolVersion — (String)

        [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

      • IpAddressType — (String)

        The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

        Possible values include:
        • "ipv4"
        • "ipv6"

Returns:

• (AWS.Request) —

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

var params = {
  CaCertificatesBundleS3Bucket: 'STRING_VALUE', /* required */
  CaCertificatesBundleS3Key: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  CaCertificatesBundleS3ObjectVersion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elbv2.createTrustStore(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: {}) —
  • Name — (String)

    The name of the trust store.

    This name must be unique per region and cannot be changed after creation.

  • CaCertificatesBundleS3Bucket — (String)

    The Amazon S3 bucket for the ca certificates bundle.

  • CaCertificatesBundleS3Key — (String)

    The Amazon S3 path for the ca certificates bundle.

  • CaCertificatesBundleS3ObjectVersion — (String)

    The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

  • Tags — (Array<map>)

    The tags to assign to the trust store.

    • 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:

    • TrustStores — (Array<map>)

      Information about the trust store created.

      • Name — (String)

        The name of the trust store.

      • TrustStoreArn — (String)

        The Amazon Resource Name (ARN) of the trust store.

      • Status — (String)

        The current status of the trust store.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
      • NumberOfCaCertificates — (Integer)

        The number of ca certificates in the trust store.

      • TotalRevokedEntries — (Integer)

        The number of revoked certificates in the trust store.

Returns:

• (AWS.Request) —

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

/* This example deletes the specified listener. */

 var params = {
  ListenerArn: "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
 };
 elbv2.deleteListener(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  ListenerArn: 'STRING_VALUE' /* required */
};
elbv2.deleteListener(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: {}) —
  • ListenerArn — (String)

    The Amazon Resource Name (ARN) of the listener.

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 = {
  LoadBalancerArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
 };
 elbv2.deleteLoadBalancer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  LoadBalancerArn: 'STRING_VALUE' /* required */
};
elbv2.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: {}) —
  • LoadBalancerArn — (String)

    The Amazon Resource Name (ARN) 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 specified rule. */

 var params = {
  RuleArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"
 };
 elbv2.deleteRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  RuleArn: 'STRING_VALUE' /* required */
};
elbv2.deleteRule(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: {}) —
  • RuleArn — (String)

    The Amazon Resource Name (ARN) of the rule.

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 association between the specified trust store and the specified load balancer. */

 var params = {
  ResourceArn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-load-balancer/80233fa81d678c2c", 
  TrustStoreArn: "arn:aws:elasticloadbalancing:us-east-1:123456789012:truststore/my-trust-store/73e2d6bc24d8a063"
 };
 elbv2.deleteSharedTrustStoreAssociation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TrustStoreArn: 'STRING_VALUE' /* required */
};
elbv2.deleteSharedTrustStoreAssociation(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: {}) —
  • TrustStoreArn — (String)

    The Amazon Resource Name (ARN) of the trust store.

  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

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 target group. */

 var params = {
  TargetGroupArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
 };
 elbv2.deleteTargetGroup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  TargetGroupArn: 'STRING_VALUE' /* required */
};
elbv2.deleteTargetGroup(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: {}) —
  • TargetGroupArn — (String)

    The Amazon Resource Name (ARN) of the target 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.

Returns:

• (AWS.Request) —

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

var params = {
  TrustStoreArn: 'STRING_VALUE' /* required */
};
elbv2.deleteTrustStore(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: {}) —
  • TrustStoreArn — (String)

    The Amazon Resource Name (ARN) of the trust store.

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 target group. */

 var params = {
  TargetGroupArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
  Targets: [
     {
    Id: "i-0f76fade"
   }
  ]
 };
 elbv2.deregisterTargets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  TargetGroupArn: 'STRING_VALUE', /* required */
  Targets: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      AvailabilityZone: 'STRING_VALUE',
      Port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
elbv2.deregisterTargets(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: {}) —
  • TargetGroupArn — (String)

    The Amazon Resource Name (ARN) of the target group.

  • Targets — (Array<map>)

    The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

    • Id — required — (String)

      The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

    • Port — (Integer)

      The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.

    • AvailabilityZone — (String)

      An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

      For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

      This parameter is not supported if the target type of the target group is instance or alb.

      If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

      For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

      If the target type is lambda, this parameter is optional and the only supported value is all.

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 = {
  Marker: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
elbv2.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:

        • application-load-balancers

        • condition-values-per-alb-rule

        • condition-wildcards-per-alb-rule

        • gateway-load-balancers

        • gateway-load-balancers-per-vpc

        • geneve-target-groups

        • listeners-per-application-load-balancer

        • listeners-per-network-load-balancer

        • network-load-balancers

        • rules-per-application-load-balancer

        • target-groups

        • target-groups-per-action-on-application-load-balancer

        • target-groups-per-action-on-network-load-balancer

        • target-groups-per-application-load-balancer

        • targets-per-application-load-balancer

        • targets-per-availability-zone-per-gateway-load-balancer

        • targets-per-availability-zone-per-network-load-balancer

        • targets-per-network-load-balancer

      • Max — (String)

        The maximum value of the limit.

    • NextMarker — (String)

      If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

Returns:

• (AWS.Request) —

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

/* This example describes the attributes of the specified listener. */

 var params = {
  ListenerArn: "aws:elasticloadbalancing:us-east-1:123456789012:listener/net/my-listener/73e2d6bc24d8a067/d5dc06411fa5bcea"
 };
 elbv2.describeListenerAttributes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  ListenerArn: 'STRING_VALUE' /* required */
};
elbv2.describeListenerAttributes(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: {}) —
  • ListenerArn — (String)

    The Amazon Resource Name (ARN) of the listener.

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:

    • Attributes — (Array<map>)

      Information about the listener attributes.

      • Key — (String)

        The name of the attribute.

        The following attribute is supported by Network Load Balancers, and Gateway Load Balancers.

        • tcp.idle_timeout.seconds - The tcp idle timeout value, in seconds. The valid range is 60-6000 seconds. The default is 350 seconds.

      • Value — (String)

        The value of the attribute.

Returns:

• (AWS.Request) —

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

var params = {
  ListenerArn: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
elbv2.describeListenerCertificates(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: {}) —
  • ListenerArn — (String)

    The Amazon Resource Names (ARN) of the listener.

  • 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:

    • Certificates — (Array<map>)

      Information about the certificates.

      • CertificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate.

      • IsDefault — (Boolean)

        Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

    • NextMarker — (String)

      If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

Returns:

• (AWS.Request) —

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

/* This example describes the specified listener. */

 var params = {
  ListenerArns: [
     "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
  ]
 };
 elbv2.describeListeners(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Listeners: [
       {
      DefaultActions: [
         {
        TargetGroupArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 
        Type: "forward"
       }
      ], 
      ListenerArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 
      LoadBalancerArn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 
      Port: 80, 
      Protocol: "HTTP"
     }
    ]
   }
   */
 });

var params = {
  ListenerArns: [
    'STRING_VALUE',
    /* more items */
  ],
  LoadBalancerArn: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
elbv2.describeListeners(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: {}) —
  • LoadBalancerArn — (String)

    The Amazon Resource Name (ARN) of the load balancer.

  • ListenerArns — (Array<String>)

    The Amazon Resource Names (ARN) of the listeners.

  • 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:

    • Listeners — (Array<map>)

      Information about the listeners.

      • ListenerArn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • LoadBalancerArn — (String)

        The Amazon Resource Name (ARN) of the load balancer.

      • Port — (Integer)

        The port on which the load balancer is listening.

      • Protocol — (String)

        The protocol for connections from clients to the load balancer.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
        • "TLS"
        • "UDP"
        • "TCP_UDP"
        • "GENEVE"
      • Certificates — (Array<map>)

        [HTTPS or TLS listener] The default certificate for the listener.

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) of the certificate.

        • IsDefault — (Boolean)

          Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

      • SslPolicy — (String)

        [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

      • DefaultActions — (Array<map>)

        The default actions for the listener.

        • Type — required — (String)

          The type of action.

          Possible values include:
          • "forward"
          • "authenticate-oidc"
          • "authenticate-cognito"
          • "redirect"
          • "fixed-response"
        • TargetGroupArn — (String)

          The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

        • AuthenticateOidcConfig — (map)

          [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

          • Issuer — required — (String)

            The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

          • AuthorizationEndpoint — required — (String)

            The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

          • TokenEndpoint — required — (String)

            The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

          • UserInfoEndpoint — required — (String)

            The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

          • ClientId — required — (String)

            The OAuth 2.0 client identifier.

          • ClientSecret — (String)

            The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

          • SessionCookieName — (String)

            The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

          • Scope — (String)

            The set of user claims to be requested from the IdP. The default is openid.

            To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

          • SessionTimeout — (Integer)

            The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

          • AuthenticationRequestExtraParams — (map<String>)

            The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

          • OnUnauthenticatedRequest — (String)

            The behavior if the user is not authenticated. The following are possible values:

            • deny - Return an HTTP 401 Unauthorized error.

            • allow - Allow the request to be forwarded to the target.

            • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

            Possible values include:
            • "deny"
            • "allow"
            • "authenticate"
          • UseExistingClientSecret — (Boolean)

            Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

        • AuthenticateCognitoConfig — (map)

          [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

          • UserPoolArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

          • UserPoolClientId — required — (String)

            The ID of the Amazon Cognito user pool client.

          • UserPoolDomain — required — (String)

            The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

          • SessionCookieName — (String)

            The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

          • Scope — (String)

            The set of user claims to be requested from the IdP. The default is openid.

            To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

          • SessionTimeout — (Integer)

            The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

          • AuthenticationRequestExtraParams — (map<String>)

            The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

          • OnUnauthenticatedRequest — (String)

            The behavior if the user is not authenticated. The following are possible values:

            • deny - Return an HTTP 401 Unauthorized error.

            • allow - Allow the request to be forwarded to the target.

            • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

            Possible values include:
            • "deny"
            • "allow"
            • "authenticate"
        • Order — (Integer)

          The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

        • RedirectConfig — (map)

          [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

          • Protocol — (String)

            The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

          • Port — (String)

            The port. You can specify a value from 1 to 65535 or #{port}.

          • Host — (String)

            The hostname. This component is not percent-encoded. The hostname can contain #{host}.

          • Path — (String)

            The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

          • Query — (String)

            The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

          • StatusCode — required — (String)

            The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

            Possible values include:
            • "HTTP_301"
            • "HTTP_302"
        • FixedResponseConfig — (map)

          [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

          • MessageBody — (String)

            The message.

          • StatusCode — required — (String)

            The HTTP response code (2XX, 4XX, or 5XX).

          • ContentType — (String)

            The content type.

            Valid Values: text/plain | text/css | text/html | application/javascript | application/json

        • ForwardConfig — (map)

          Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

          • TargetGroups — (Array<map>)

            The target groups. For Network Load Balancers, you can specify a single target group.

            • TargetGroupArn — (String)

              The Amazon Resource Name (ARN) of the target group.

            • Weight — (Integer)

              The weight. The range is 0 to 999.

          • TargetGroupStickinessConfig — (map)

            The target group stickiness for the rule.

            • Enabled — (Boolean)

              Indicates whether target group stickiness is enabled.

            • DurationSeconds — (Integer)

              The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

      • AlpnPolicy — (Array<String>)

        [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

      • MutualAuthentication — (map)

        The mutual authentication configuration information.

        • Mode — (String)

          The client certificate handling method. Options are off, passthrough or verify. The default value is off.

        • TrustStoreArn — (String)

          The Amazon Resource Name (ARN) of the trust store.

        • IgnoreClientCertificateExpiry — (Boolean)

          Indicates whether expired client certificates are ignored.

        • TrustStoreAssociationStatus — (String)

          Indicates a shared trust stores association status.

          Possible values include:
          • "active"
          • "removed"
    • NextMarker — (String)

      If there are additional results, this is the marker for the next set of results. Otherwise, this is null.