Skip to content
v2.275.0

LoadBalancerProps Struct ​

Construction properties for a LoadBalancer.

Example ​

ts
declare const cluster: ecs.Cluster;
declare const taskDefinition: ecs.TaskDefinition;
declare const vpc: ec2.Vpc;
const service = new ecs.Ec2Service(this, 'Service', { cluster, taskDefinition, minHealthyPercent: 100 });

const lb = new elb.LoadBalancer(this, 'LB', { vpc });
lb.addListener({ externalPort: 80 });
lb.addTarget(service);

Properties ​

accessLoggingPolicyoptionalCfnLoadBalancer.AccessLoggingPolicyPropertyaccess_logging_policyoptionalAccessLoggingPolicyPropertyaccessLoggingPolicyoptionalAccessLoggingPolicyPropertyAccessLoggingPolicyoptionalAccessLoggingPolicyPropertyAccessLoggingPolicyoptionalAccessLoggingPolicyProperty= disabled#
Enable Loadbalancer access logs Can be used to avoid manual work as aws console Required S3 bucket name , enabled flag Can add interval for pushing log Can set bucket prefix in order to provide folder name inside bucket.
crossZoneoptionalbooleancross_zoneoptionalboolcrossZoneoptionalBooleanCrossZoneoptionalboolCrossZoneoptional*bool= true#
Whether cross zone load balancing is enabled.

This controls whether the load balancer evenly distributes requests across each availability zone

healthCheckoptionalHealthCheckhealth_checkoptionalHealthCheckhealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheck= None.#
Health check settings for the load balancing targets.

Not required but recommended.

internetFacingoptionalbooleaninternet_facingoptionalboolinternetFacingoptionalBooleanInternetFacingoptionalboolInternetFacingoptional*bool= false#
Whether this is an internet-facing Load Balancer.

This controls whether the LB has a public IP address assigned. It does not open up the Load Balancer's security groups to public internet access.

listenersoptionalLoadBalancerListener[]listenersoptionaltyping.List[LoadBalancerListener]listenersoptionalList<LoadBalancerListener>ListenersoptionalLoadBalancerListener[]Listenersoptional*[]LoadBalancerListener#
What listeners to set up for the load balancer.

Can also be added by .addListener()

subnetSelectionoptionalSubnetSelectionsubnet_selectionoptionalSubnetSelectionsubnetSelectionoptionalSubnetSelectionSubnetSelectionoptionalSubnetSelectionSubnetSelectionoptionalSubnetSelection#
Which subnets to deploy the load balancer.

Default: Public subnets if internetFacing, Private subnets otherwise

Can be used to define a specific set of subnets to deploy the load balancer to. Useful multiple public or private subnets are covering the same availability zone.

targetsoptionalILoadBalancerTarget[]targetsoptionaltyping.List[ILoadBalancerTarget]targetsoptionalList<ILoadBalancerTarget>TargetsoptionalILoadBalancerTarget[]Targetsoptional*[]ILoadBalancerTarget= None.#
What targets to load balance to.

Can also be added by .addTarget()

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#
VPC network of the fleet instances.