AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ElasticLoadBalancing::LoadBalancer

CfnLoadBalancer

Specifies a Classic Load Balancer. If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the VPC-gateway attachment.

Import

import { CfnLoadBalancer } from 'aws-cdk-lib/aws-elasticloadbalancing';

Or use the module namespace:

import * as elasticloadbalancing from 'aws-cdk-lib/aws-elasticloadbalancing';
// elasticloadbalancing.CfnLoadBalancer

Properties

Configuration passed to the constructor as CfnLoadBalancerProps.

listenersRequired
IResolvable | IResolvable | ListenersProperty[]

The listeners for the load balancer. You can specify at most one listener per port. If you update the properties for a listener, AWS CloudFormation deletes the existing listener and creates a new one with the specified properties. While the new listener is being created, clients cannot connect to the load balancer.

accessLoggingPolicyOptional
IResolvable | AccessLoggingPolicyProperty

Information about where and how access logs are stored for the load balancer.

appCookieStickinessPolicyOptional
IResolvable | IResolvable | AppCookieStickinessPolicyProperty[]

Information about a policy for application-controlled session stickiness.

availabilityZonesOptional
string[]

The Availability Zones for a load balancer in a default VPC. For a load balancer in a nondefault VPC, specify `Subnets` instead. Update requires replacement if you did not previously specify an Availability Zone or if you are removing all Availability Zones. Otherwise, update requires no interruption.

connectionDrainingPolicyOptional
IResolvable | ConnectionDrainingPolicyProperty

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](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) in the *User Guide for Classic Load Balancers* .

connectionSettingsOptional
IResolvable | ConnectionSettingsProperty

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](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) in the *User Guide for Classic Load Balancers* .

crossZoneOptional
boolean | IResolvable

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](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) in the *User Guide for Classic Load Balancers* .

healthCheckOptional
IResolvable | HealthCheckProperty

The health check settings to use when evaluating the health of your EC2 instances. Update requires replacement if you did not previously specify health check settings or if you are removing the health check settings. Otherwise, update requires no interruption.

instancesOptional
string | IInstanceRef[]

The IDs of the instances for the load balancer.

lbCookieStickinessPolicyOptional
IResolvable | IResolvable | LBCookieStickinessPolicyProperty[]

Information about a policy for duration-based session stickiness.

loadBalancerNameOptional
string

The name of the load balancer. This name must be unique within your set of load balancers for the region. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) . If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.

policiesOptional
IResolvable | IResolvable | PoliciesProperty[]

The policies defined for your Classic Load Balancer. Specify only back-end server policies.

schemeOptional
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.

securityGroupsOptional
string | ISecurityGroupRef[]

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

subnetsOptional
string | ISubnetRef[]

The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone. Update requires replacement if you did not previously specify a subnet or if you are removing all subnets. Otherwise, update requires no interruption. To update to a different subnet in the current Availability Zone, you must first update to a subnet in a different Availability Zone, then update to the new subnet in the original Availability Zone.

tagsOptional
CfnTag[]

The tags associated with a load balancer.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-elasticloadbalancing
CFN TypeAWS::ElasticLoadBalancing::LoadBalancer
Properties16

Related Constructs

External Links