aws-cdk-lib.aws_lightsail.CfnLoadBalancer

class CfnLoadBalancer (construct)

LanguageType name
.NETAmazon.CDK.AWS.Lightsail.CfnLoadBalancer
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnLoadBalancer
Javasoftware.amazon.awscdk.services.lightsail.CfnLoadBalancer
Pythonaws_cdk.aws_lightsail.CfnLoadBalancer
TypeScript aws-cdk-lib » aws_lightsail » CfnLoadBalancer

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::Lightsail::LoadBalancer.

The AWS::Lightsail::LoadBalancer resource specifies a load balancer that can be used with Lightsail instances.

You cannot attach a TLS certificate to a load balancer using the AWS::Lightsail::LoadBalancer resource type. Instead, use the AWS::Lightsail::LoadBalancerTlsCertificate resource type to create a certificate and attach it to a load balancer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const cfnLoadBalancer = new lightsail.CfnLoadBalancer(this, 'MyCfnLoadBalancer', {
  instancePort: 123,
  loadBalancerName: 'loadBalancerName',

  // the properties below are optional
  attachedInstances: ['attachedInstances'],
  healthCheckPath: 'healthCheckPath',
  ipAddressType: 'ipAddressType',
  sessionStickinessEnabled: false,
  sessionStickinessLbCookieDurationSeconds: 'sessionStickinessLbCookieDurationSeconds',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tlsPolicyName: 'tlsPolicyName',
});

Initializer

new CfnLoadBalancer(scope: Construct, id: string, props: CfnLoadBalancerProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnLoadBalancerProps — - resource properties.

Create a new AWS::Lightsail::LoadBalancer.

Construct Props

NameTypeDescription
instancePortnumberThe port that the load balancer uses to direct traffic to your Lightsail instances.
loadBalancerNamestringThe name of the load balancer.
attachedInstances?string[]The Lightsail instances to attach to the load balancer.
healthCheckPath?stringThe path on the attached instance where the health check will be performed.
ipAddressType?stringThe IP address type of the load balancer.
sessionStickinessEnabled?boolean | IResolvableA Boolean value indicating whether session stickiness is enabled.
sessionStickinessLbCookieDurationSeconds?stringThe time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
tlsPolicyName?stringThe name of the TLS security policy for the load balancer.

instancePort

Type: number

The port that the load balancer uses to direct traffic to your Lightsail instances.

For HTTP traffic, specify port 80 . For HTTPS traffic, specify port 443 .


loadBalancerName

Type: string

The name of the load balancer.


attachedInstances?

Type: string[] (optional)

The Lightsail instances to attach to the load balancer.


healthCheckPath?

Type: string (optional)

The path on the attached instance where the health check will be performed.

If no path is specified, the load balancer tries to make a request to the default (root) page ( /index.html ).


ipAddressType?

Type: string (optional)

The IP address type of the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for both IPv4 and IPv6.


sessionStickinessEnabled?

Type: boolean | IResolvable (optional)

A Boolean value indicating whether session stickiness is enabled.

Enable session stickiness (also known as session affinity ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.


sessionStickinessLbCookieDurationSeconds?

Type: string (optional)

The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.

If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.


tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.


tlsPolicyName?

Type: string (optional)

The name of the TLS security policy for the load balancer.

Properties

NameTypeDescription
attrLoadBalancerArnstringThe Amazon Resource Name (ARN) of the load balancer.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
instancePortnumberThe port that the load balancer uses to direct traffic to your Lightsail instances.
loadBalancerNamestringThe name of the load balancer.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerAn array of key-value pairs to apply to this resource.
attachedInstances?string[]The Lightsail instances to attach to the load balancer.
healthCheckPath?stringThe path on the attached instance where the health check will be performed.
ipAddressType?stringThe IP address type of the load balancer.
sessionStickinessEnabled?boolean | IResolvableA Boolean value indicating whether session stickiness is enabled.
sessionStickinessLbCookieDurationSeconds?stringThe time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.
tlsPolicyName?stringThe name of the TLS security policy for the load balancer.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrLoadBalancerArn

Type: string

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


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


instancePort

Type: number

The port that the load balancer uses to direct traffic to your Lightsail instances.

For HTTP traffic, specify port 80 . For HTTPS traffic, specify port 443 .


loadBalancerName

Type: string

The name of the load balancer.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.


attachedInstances?

Type: string[] (optional)

The Lightsail instances to attach to the load balancer.


healthCheckPath?

Type: string (optional)

The path on the attached instance where the health check will be performed.

If no path is specified, the load balancer tries to make a request to the default (root) page ( /index.html ).


ipAddressType?

Type: string (optional)

The IP address type of the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for both IPv4 and IPv6.


sessionStickinessEnabled?

Type: boolean | IResolvable (optional)

A Boolean value indicating whether session stickiness is enabled.

Enable session stickiness (also known as session affinity ) to bind a user's session to a specific instance. This ensures that all requests from the user during the session are sent to the same instance.


sessionStickinessLbCookieDurationSeconds?

Type: string (optional)

The time period, in seconds, after which the load balancer session stickiness cookie should be considered stale.

If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.


tlsPolicyName?

Type: string (optional)

The name of the TLS security policy for the load balancer.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }