Class GuHttpsClassicLoadBalancer

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

This construct creates a classic load balancer which accepts HTTPS traffic. It communicates with EC2 instances over port 9000 by default. This default can be overridden via the listener prop, for example:

new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
    // other props
    listener: {
      internalPort: 3000,
    },
  });

You can pass a certificate id to this construct via the listener interface, for example:

new GuHttpsClassicLoadBalancer(stack, "HttpsClassicLoadBalancer", {
    // other props
    listener: {
      sslCertificateId: "certificateId",
    },
  });

If certificate id is omitted the library will create a Parameter which allows you to pass in a certificate ARN.

For more details on migrating an existing load balancer and general load balancer defaults, see [[GuClassicLoadBalancer]].

Hierarchy

Constructors

constructor

Properties

connections env idWithApp listenerPorts node physicalName stack DefaultHealthCheck DefaultListener

Accessors

loadBalancerCanonicalHostedZoneName loadBalancerCanonicalHostedZoneNameId loadBalancerDnsName loadBalancerName loadBalancerSourceSecurityGroupGroupName loadBalancerSourceSecurityGroupOwnerAlias

Methods

_addInstanceId _enableCrossEnvironment addListener addTarget applyRemovalPolicy generatePhysicalName getResourceArnAttribute getResourceNameAttribute toString isConstruct isOwnedResource isResource

Constructors

constructor

Properties

Readonly connections

connections: Connections

Control all connections from and to this load balancer

Readonly env

env: ResourceEnvironment

Readonly idWithApp

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.

Readonly listenerPorts

listenerPorts: ListenerPort[]

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

Readonly node

node: Node

The tree node.

Protected Readonly physicalName

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.

Readonly stack

stack: Stack

Static DefaultHealthCheck

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

Static DefaultListener

DefaultListener: LoadBalancerListener = ...

Accessors

loadBalancerCanonicalHostedZoneName

  • get loadBalancerCanonicalHostedZoneName(): string

  • Returns string

    Attribute

loadBalancerCanonicalHostedZoneNameId

  • get loadBalancerCanonicalHostedZoneNameId(): string

  • Returns string

    Attribute

loadBalancerDnsName

  • get loadBalancerDnsName(): string

  • Returns string

    Attribute

loadBalancerName

  • get loadBalancerName(): string

  • Returns string

    Attribute

loadBalancerSourceSecurityGroupGroupName

  • get loadBalancerSourceSecurityGroupGroupName(): string

  • Returns string

    Attribute

loadBalancerSourceSecurityGroupOwnerAlias

  • get loadBalancerSourceSecurityGroupOwnerAlias(): string

  • Returns string

    Attribute

Methods

_addInstanceId

  • _addInstanceId(instanceId): void
  • Internal

    Add instance to the load balancer.

    Parameters

    • instanceId: string

    Returns void

_enableCrossEnvironment

  • _enableCrossEnvironment(): 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

addListener

  • Add a backend to the load balancer

    Parameters

    • listener: LoadBalancerListener

    Returns ListenerPort

    A ListenerPort object that controls connections to the listener port

addTarget

  • Parameters

    • target: ILoadBalancerTarget

    Returns void

applyRemovalPolicy

  • 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).

    Parameters

    • policy: RemovalPolicy

    Returns void

Protected generatePhysicalName

Protected getResourceArnAttribute

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

    Parameters

    • 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

Protected getResourceNameAttribute

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

    Parameters

    • nameAttr: string

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

    Returns string

toString

  • Returns a string representation of an object.

    Returns string

Static isConstruct

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

    Parameters

    • x: any

      Any object

    Returns x is Construct

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

Static isOwnedResource

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

    Parameters

    • construct: IConstruct

    Returns boolean

Static isResource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc