1.204.0

class CfnLoadBalancer (construct)

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancing.CfnLoadBalancer
Javasoftware.amazon.awscdk.services.elasticloadbalancing.CfnLoadBalancer
Pythonaws_cdk.aws_elasticloadbalancing.CfnLoadBalancer
TypeScript @aws-cdk/aws-elasticloadbalancing » CfnLoadBalancer

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ElasticLoadBalancing::LoadBalancer.

Specifies a Classic Load Balancer.

You can specify the AvailabilityZones or Subnets property, but not both.

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 to declare a dependency on the VPC-gateway attachment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elb from '@aws-cdk/aws-elasticloadbalancing';

declare const attributes: any;
const cfnLoadBalancer = new elb.CfnLoadBalancer(this, 'MyCfnLoadBalancer', {
  listeners: [{
    instancePort: 'instancePort',
    loadBalancerPort: 'loadBalancerPort',
    protocol: 'protocol',

    // the properties below are optional
    instanceProtocol: 'instanceProtocol',
    policyNames: ['policyNames'],
    sslCertificateId: 'sslCertificateId',
  }],

  // the properties below are optional
  accessLoggingPolicy: {
    enabled: false,
    s3BucketName: 's3BucketName',

    // the properties below are optional
    emitInterval: 123,
    s3BucketPrefix: 's3BucketPrefix',
  },
  appCookieStickinessPolicy: [{
    cookieName: 'cookieName',
    policyName: 'policyName',
  }],
  availabilityZones: ['availabilityZones'],
  connectionDrainingPolicy: {
    enabled: false,

    // the properties below are optional
    timeout: 123,
  },
  connectionSettings: {
    idleTimeout: 123,
  },
  crossZone: false,
  healthCheck: {
    healthyThreshold: 'healthyThreshold',
    interval: 'interval',
    target: 'target',
    timeout: 'timeout',
    unhealthyThreshold: 'unhealthyThreshold',
  },
  instances: ['instances'],
  lbCookieStickinessPolicy: [{
    cookieExpirationPeriod: 'cookieExpirationPeriod',
    policyName: 'policyName',
  }],
  loadBalancerName: 'loadBalancerName',
  policies: [{
    attributes: [attributes],
    policyName: 'policyName',
    policyType: 'policyType',

    // the properties below are optional
    instancePorts: ['instancePorts'],
    loadBalancerPorts: ['loadBalancerPorts'],
  }],
  scheme: 'scheme',
  securityGroups: ['securityGroups'],
  subnets: ['subnets'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

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::ElasticLoadBalancing::LoadBalancer.

Construct Props

NameTypeDescription
listenersIResolvable | ListenersProperty | IResolvable[]The listeners for the load balancer. You can specify at most one listener per port.
accessLoggingPolicy?IResolvable | AccessLoggingPolicyPropertyInformation about where and how access logs are stored for the load balancer.
appCookieStickinessPolicy?IResolvable | IResolvable | AppCookieStickinessPolicyProperty[]Information about a policy for application-controlled session stickiness.
availabilityZones?string[]The Availability Zones for the load balancer. For load balancers in a VPC, specify Subnets instead.
connectionDrainingPolicy?IResolvable | ConnectionDrainingPolicyPropertyIf enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
connectionSettings?IResolvable | ConnectionSettingsPropertyIf enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
crossZone?boolean | IResolvableIf enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
healthCheck?IResolvable | HealthCheckPropertyThe health check settings to use when evaluating the health of your EC2 instances.
instances?string[]The IDs of the instances for the load balancer.
lbCookieStickinessPolicy?IResolvable | IResolvable | LBCookieStickinessPolicyProperty[]Information about a policy for duration-based session stickiness.
loadBalancerName?stringThe name of the load balancer.
policies?IResolvable | IResolvable | PoliciesProperty[]The policies defined for your Classic Load Balancer.
scheme?stringThe type of load balancer. Valid only for load balancers in a VPC.
securityGroups?string[]The security groups for the load balancer.
subnets?string[]The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
tags?CfnTag[]The tags associated with a load balancer.

listeners

Type: IResolvable | ListenersProperty | IResolvable[]

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.

accessLoggingPolicy?

Type: IResolvable | AccessLoggingPolicyProperty (optional)

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

appCookieStickinessPolicy?

Type: IResolvable | IResolvable | AppCookieStickinessPolicyProperty[] (optional)

Information about a policy for application-controlled session stickiness.

availabilityZones?

Type: string[] (optional)

The Availability Zones for the load balancer. For load balancers in a 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.

connectionDrainingPolicy?

Type: IResolvable | ConnectionDrainingPolicyProperty (optional)

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 in the Classic Load Balancers Guide .

connectionSettings?

Type: IResolvable | ConnectionSettingsProperty (optional)

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 in the Classic Load Balancers Guide .

crossZone?

Type: boolean | IResolvable (optional)

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 in the Classic Load Balancers Guide .

healthCheck?

Type: IResolvable | HealthCheckProperty (optional)

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.

instances?

Type: string[] (optional)

The IDs of the instances for the load balancer.

lbCookieStickinessPolicy?

Type: IResolvable | IResolvable | LBCookieStickinessPolicyProperty[] (optional)

Information about a policy for duration-based session stickiness.

loadBalancerName?

Type: string (optional)

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

policies?

Type: IResolvable | IResolvable | PoliciesProperty[] (optional)

The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

scheme?

Type: string (optional)

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.

securityGroups?

Type: string[] (optional)

The security groups for the load balancer.

Valid only for load balancers in a VPC.

subnets?

Type: string[] (optional)

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.

tags?

Type: CfnTag[] (optional)

The tags associated with a load balancer.

Properties

NameTypeDescription
attrCanonicalHostedZoneNamestringThe name of the Route 53 hosted zone that is associated with the load balancer.
attrCanonicalHostedZoneNameIdstringThe ID of the Route 53 hosted zone name that is associated with the load balancer.
attrDnsNamestringThe DNS name for the load balancer.
attrSourceSecurityGroupGroupNamestringThe name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.
attrSourceSecurityGroupOwnerAliasstringThe owner of the source security group.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
listenersIResolvable | ListenersProperty | IResolvable[]The listeners for the load balancer. You can specify at most one listener per port.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags associated with a load balancer.
accessLoggingPolicy?IResolvable | AccessLoggingPolicyPropertyInformation about where and how access logs are stored for the load balancer.
appCookieStickinessPolicy?IResolvable | IResolvable | AppCookieStickinessPolicyProperty[]Information about a policy for application-controlled session stickiness.
availabilityZones?string[]The Availability Zones for the load balancer. For load balancers in a VPC, specify Subnets instead.
connectionDrainingPolicy?IResolvable | ConnectionDrainingPolicyPropertyIf enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
connectionSettings?IResolvable | ConnectionSettingsPropertyIf enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
crossZone?boolean | IResolvableIf enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
healthCheck?IResolvable | HealthCheckPropertyThe health check settings to use when evaluating the health of your EC2 instances.
instances?string[]The IDs of the instances for the load balancer.
lbCookieStickinessPolicy?IResolvable | IResolvable | LBCookieStickinessPolicyProperty[]Information about a policy for duration-based session stickiness.
loadBalancerName?stringThe name of the load balancer.
policies?IResolvable | IResolvable | PoliciesProperty[]The policies defined for your Classic Load Balancer.
scheme?stringThe type of load balancer. Valid only for load balancers in a VPC.
securityGroups?string[]The security groups for the load balancer.
subnets?string[]The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrCanonicalHostedZoneName

Type: string

The name of the Route 53 hosted zone that is associated with the load balancer.

Internal-facing load balancers don't use this value, use DNSName instead.

attrCanonicalHostedZoneNameId

Type: string

The ID of the Route 53 hosted zone name that is associated with the load balancer.

attrDnsName

Type: string

The DNS name for the load balancer.

attrSourceSecurityGroupGroupName

Type: string

The name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.

attrSourceSecurityGroupOwnerAlias

Type: string

The owner of the source security group.

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[]

listeners

Type: IResolvable | ListenersProperty | IResolvable[]

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.

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: ConstructNode

The construct tree node associated with this construct.

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

The tags associated with a load balancer.

accessLoggingPolicy?

Type: IResolvable | AccessLoggingPolicyProperty (optional)

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

appCookieStickinessPolicy?

Type: IResolvable | IResolvable | AppCookieStickinessPolicyProperty[] (optional)

Information about a policy for application-controlled session stickiness.

availabilityZones?

Type: string[] (optional)

The Availability Zones for the load balancer. For load balancers in a 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.

connectionDrainingPolicy?

Type: IResolvable | ConnectionDrainingPolicyProperty (optional)

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 in the Classic Load Balancers Guide .

connectionSettings?

Type: IResolvable | ConnectionSettingsProperty (optional)

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 in the Classic Load Balancers Guide .

crossZone?

Type: boolean | IResolvable (optional)

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 in the Classic Load Balancers Guide .

healthCheck?

Type: IResolvable | HealthCheckProperty (optional)

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.

instances?

Type: string[] (optional)

The IDs of the instances for the load balancer.

lbCookieStickinessPolicy?

Type: IResolvable | IResolvable | LBCookieStickinessPolicyProperty[] (optional)

Information about a policy for duration-based session stickiness.

loadBalancerName?

Type: string (optional)

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

policies?

Type: IResolvable | IResolvable | PoliciesProperty[] (optional)

The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

scheme?

Type: string (optional)

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.

securityGroups?

Type: string[] (optional)

The security groups for the load balancer.

Valid only for load balancers in a VPC.

subnets?

Type: string[] (optional)

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.

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).
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)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.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
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).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

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.

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

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

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.

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.

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 }
← PreviousNext →