IMPORTANT: This construct should only be used if you are migrating an existing stack and you need to retain the load balancer. Please use [[GuApplicationLoadBalancer]] instead of [[GuClassicLoadBalancer]] wherever possible.

By default, load balancers created via this construct will perform a healthcheck against /healthcheck on port 9000. All healthcheck defaults can be overridden via the healthcheck prop.

For example, to use /test for the healthcheck path use:

new GuClassicLoadBalancer(stack, "ClassicLoadBalancer", {
// other props
healthCheck: {
path: "/test",

If you are running an application which only accepts traffic over HTTPs, consider using [[GuHttpsClassicLoadBalancer]] to reduce the amount of boilerplate needed when configuring your load balancer.

This resource is stateful.




connections: Connections

Control all connections from and to this load balancer

env: ResourceEnvironment
idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

listenerPorts: ListenerPort[]

An object controlling specifically the connections for each listener added to this load balancer

node: Node

The tree node.

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.
stack: Stack
DefaultHealthCheck: {
    healthyThreshold: number;
    interval: Duration;
    path: string;
    port: number;
    protocol: LoadBalancingProtocol;
    timeout: Duration;
    unhealthyThreshold: number;
} = ...

Type declaration

  • healthyThreshold: number
  • interval: Duration
  • path: string
  • port: number
  • protocol: LoadBalancingProtocol
  • timeout: Duration
  • unhealthyThreshold: number


  • get loadBalancerCanonicalHostedZoneName(): string
  • Returns string


  • get loadBalancerCanonicalHostedZoneNameId(): string
  • Returns string


  • get loadBalancerDnsName(): string
  • Returns string


  • get loadBalancerName(): string
  • Returns string


  • get loadBalancerSourceSecurityGroupGroupName(): string
  • Returns string


  • get loadBalancerSourceSecurityGroupOwnerAlias(): string
  • Returns string



  • Internal

    Add instance to the load balancer.


    • instanceId: string

    Returns void

  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

  • Add a backend to the load balancer


    • listener: LoadBalancerListener

    Returns ListenerPort

    A ListenerPort object that controls connections to the listener port

  • Parameters

    • target: ILoadBalancerTarget

    Returns void

  • Apply the given removal policy to this resource

    The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

    The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


    • policy: RemovalPolicy

    Returns void

  • Returns string

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.


    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.


    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

  • Returns a string representation of an object.

    Returns string

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.


    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

  • Returns true if the construct was created by CDK, and false otherwise


    • construct: IConstruct

    Returns boolean

  • Check whether the given construct is a Resource


    • construct: IConstruct

    Returns construct is Resource

Generated using TypeDoc