Skip to content
v2.277.0

CfnLoadBalancerProps Struct ​

Properties for defining a CfnLoadBalancer.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancing as elb } from 'aws-cdk-lib';

declare const attributes: any;
const cfnLoadBalancerProps: elb.CfnLoadBalancerProps = {
  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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticloadbalancing as elb

# attributes: Any

cfn_load_balancer_props = elb.CfnLoadBalancerProps(
    listeners=[elb.CfnLoadBalancer.ListenersProperty(
        instance_port="instancePort",
        load_balancer_port="loadBalancerPort",
        protocol="protocol",

        # the properties below are optional
        instance_protocol="instanceProtocol",
        policy_names=["policyNames"],
        ssl_certificate_id="sslCertificateId"
    )],

    # the properties below are optional
    access_logging_policy=elb.CfnLoadBalancer.AccessLoggingPolicyProperty(
        enabled=False,
        s3_bucket_name="s3BucketName",

        # the properties below are optional
        emit_interval=123,
        s3_bucket_prefix="s3BucketPrefix"
    ),
    app_cookie_stickiness_policy=[elb.CfnLoadBalancer.AppCookieStickinessPolicyProperty(
        cookie_name="cookieName",
        policy_name="policyName"
    )],
    availability_zones=["availabilityZones"],
    connection_draining_policy=elb.CfnLoadBalancer.ConnectionDrainingPolicyProperty(
        enabled=False,

        # the properties below are optional
        timeout=123
    ),
    connection_settings=elb.CfnLoadBalancer.ConnectionSettingsProperty(
        idle_timeout=123
    ),
    cross_zone=False,
    health_check=elb.CfnLoadBalancer.HealthCheckProperty(
        healthy_threshold="healthyThreshold",
        interval="interval",
        target="target",
        timeout="timeout",
        unhealthy_threshold="unhealthyThreshold"
    ),
    instances=["instances"],
    lb_cookie_stickiness_policy=[elb.CfnLoadBalancer.LBCookieStickinessPolicyProperty(
        cookie_expiration_period="cookieExpirationPeriod",
        policy_name="policyName"
    )],
    load_balancer_name="loadBalancerName",
    policies=[elb.CfnLoadBalancer.PoliciesProperty(
        attributes=[attributes],
        policy_name="policyName",
        policy_type="policyType",

        # the properties below are optional
        instance_ports=["instancePorts"],
        load_balancer_ports=["loadBalancerPorts"]
    )],
    scheme="scheme",
    security_groups=["securityGroups"],
    subnets=["subnets"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticloadbalancing.*;

Object attributes;

CfnLoadBalancerProps cfnLoadBalancerProps = CfnLoadBalancerProps.builder()
        .listeners(List.of(ListenersProperty.builder()
                .instancePort("instancePort")
                .loadBalancerPort("loadBalancerPort")
                .protocol("protocol")

                // the properties below are optional
                .instanceProtocol("instanceProtocol")
                .policyNames(List.of("policyNames"))
                .sslCertificateId("sslCertificateId")
                .build()))

        // the properties below are optional
        .accessLoggingPolicy(AccessLoggingPolicyProperty.builder()
                .enabled(false)
                .s3BucketName("s3BucketName")

                // the properties below are optional
                .emitInterval(123)
                .s3BucketPrefix("s3BucketPrefix")
                .build())
        .appCookieStickinessPolicy(List.of(AppCookieStickinessPolicyProperty.builder()
                .cookieName("cookieName")
                .policyName("policyName")
                .build()))
        .availabilityZones(List.of("availabilityZones"))
        .connectionDrainingPolicy(ConnectionDrainingPolicyProperty.builder()
                .enabled(false)

                // the properties below are optional
                .timeout(123)
                .build())
        .connectionSettings(ConnectionSettingsProperty.builder()
                .idleTimeout(123)
                .build())
        .crossZone(false)
        .healthCheck(HealthCheckProperty.builder()
                .healthyThreshold("healthyThreshold")
                .interval("interval")
                .target("target")
                .timeout("timeout")
                .unhealthyThreshold("unhealthyThreshold")
                .build())
        .instances(List.of("instances"))
        .lbCookieStickinessPolicy(List.of(LBCookieStickinessPolicyProperty.builder()
                .cookieExpirationPeriod("cookieExpirationPeriod")
                .policyName("policyName")
                .build()))
        .loadBalancerName("loadBalancerName")
        .policies(List.of(PoliciesProperty.builder()
                .attributes(List.of(attributes))
                .policyName("policyName")
                .policyType("policyType")

                // the properties below are optional
                .instancePorts(List.of("instancePorts"))
                .loadBalancerPorts(List.of("loadBalancerPorts"))
                .build()))
        .scheme("scheme")
        .securityGroups(List.of("securityGroups"))
        .subnets(List.of("subnets"))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancing;

var attributes;

var cfnLoadBalancerProps = new CfnLoadBalancerProps {
    Listeners = new [] { new ListenersProperty {
        InstancePort = "instancePort",
        LoadBalancerPort = "loadBalancerPort",
        Protocol = "protocol",

        // the properties below are optional
        InstanceProtocol = "instanceProtocol",
        PolicyNames = new [] { "policyNames" },
        SslCertificateId = "sslCertificateId"
    } },

    // the properties below are optional
    AccessLoggingPolicy = new AccessLoggingPolicyProperty {
        Enabled = false,
        S3BucketName = "s3BucketName",

        // the properties below are optional
        EmitInterval = 123,
        S3BucketPrefix = "s3BucketPrefix"
    },
    AppCookieStickinessPolicy = new [] { new AppCookieStickinessPolicyProperty {
        CookieName = "cookieName",
        PolicyName = "policyName"
    } },
    AvailabilityZones = new [] { "availabilityZones" },
    ConnectionDrainingPolicy = new ConnectionDrainingPolicyProperty {
        Enabled = false,

        // the properties below are optional
        Timeout = 123
    },
    ConnectionSettings = new ConnectionSettingsProperty {
        IdleTimeout = 123
    },
    CrossZone = false,
    HealthCheck = new HealthCheckProperty {
        HealthyThreshold = "healthyThreshold",
        Interval = "interval",
        Target = "target",
        Timeout = "timeout",
        UnhealthyThreshold = "unhealthyThreshold"
    },
    Instances = new [] { "instances" },
    LbCookieStickinessPolicy = new [] { new LBCookieStickinessPolicyProperty {
        CookieExpirationPeriod = "cookieExpirationPeriod",
        PolicyName = "policyName"
    } },
    LoadBalancerName = "loadBalancerName",
    Policies = new [] { new PoliciesProperty {
        Attributes = new [] { attributes },
        PolicyName = "policyName",
        PolicyType = "policyType",

        // the properties below are optional
        InstancePorts = new [] { "instancePorts" },
        LoadBalancerPorts = new [] { "loadBalancerPorts" }
    } },
    Scheme = "scheme",
    SecurityGroups = new [] { "securityGroups" },
    Subnets = new [] { "subnets" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var attributes interface{}

cfnLoadBalancerProps := &CfnLoadBalancerProps{
	Listeners: []interface{}{
		&ListenersProperty{
			InstancePort: jsii.String("instancePort"),
			LoadBalancerPort: jsii.String("loadBalancerPort"),
			Protocol: jsii.String("protocol"),

			// the properties below are optional
			InstanceProtocol: jsii.String("instanceProtocol"),
			PolicyNames: []*string{
				jsii.String("policyNames"),
			},
			SslCertificateId: jsii.String("sslCertificateId"),
		},
	},

	// the properties below are optional
	AccessLoggingPolicy: &AccessLoggingPolicyProperty{
		Enabled: jsii.Boolean(false),
		S3BucketName: jsii.String("s3BucketName"),

		// the properties below are optional
		EmitInterval: jsii.Number(123),
		S3BucketPrefix: jsii.String("s3BucketPrefix"),
	},
	AppCookieStickinessPolicy: []interface{}{
		&AppCookieStickinessPolicyProperty{
			CookieName: jsii.String("cookieName"),
			PolicyName: jsii.String("policyName"),
		},
	},
	AvailabilityZones: []*string{
		jsii.String("availabilityZones"),
	},
	ConnectionDrainingPolicy: &ConnectionDrainingPolicyProperty{
		Enabled: jsii.Boolean(false),

		// the properties below are optional
		Timeout: jsii.Number(123),
	},
	ConnectionSettings: &ConnectionSettingsProperty{
		IdleTimeout: jsii.Number(123),
	},
	CrossZone: jsii.Boolean(false),
	HealthCheck: &HealthCheckProperty{
		HealthyThreshold: jsii.String("healthyThreshold"),
		Interval: jsii.String("interval"),
		Target: jsii.String("target"),
		Timeout: jsii.String("timeout"),
		UnhealthyThreshold: jsii.String("unhealthyThreshold"),
	},
	Instances: []interface{}{
		jsii.String("instances"),
	},
	LbCookieStickinessPolicy: []interface{}{
		&LBCookieStickinessPolicyProperty{
			CookieExpirationPeriod: jsii.String("cookieExpirationPeriod"),
			PolicyName: jsii.String("policyName"),
		},
	},
	LoadBalancerName: jsii.String("loadBalancerName"),
	Policies: []interface{}{
		&PoliciesProperty{
			Attributes: []interface{}{
				attributes,
			},
			PolicyName: jsii.String("policyName"),
			PolicyType: jsii.String("policyType"),

			// the properties below are optional
			InstancePorts: []*string{
				jsii.String("instancePorts"),
			},
			LoadBalancerPorts: []*string{
				jsii.String("loadBalancerPorts"),
			},
		},
	},
	Scheme: jsii.String("scheme"),
	SecurityGroups: []interface{}{
		jsii.String("securityGroups"),
	},
	Subnets: []interface{}{
		jsii.String("subnets"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

accessLoggingPolicyoptionalIResolvable | CfnLoadBalancer.AccessLoggingPolicyPropertyaccess_logging_policyoptionaltyping.Union[IResolvable, AccessLoggingPolicyProperty]accessLoggingPolicyoptionalIResolvableAccessLoggingPolicyoptionalIResolvableAccessLoggingPolicyoptionalinterface{}#
Information about where and how access logs are stored for the load balancer.
appCookieStickinessPolicyoptionalIResolvable | IResolvable | CfnLoadBalancer.AppCookieStickinessPolicyProperty[]app_cookie_stickiness_policyoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AppCookieStickinessPolicyProperty]]]appCookieStickinessPolicyoptionalIResolvableAppCookieStickinessPolicyoptionalIResolvableAppCookieStickinessPolicyoptionalinterface{}#
Information about a policy for application-controlled session stickiness.
availabilityZonesoptionalstring[]availability_zonesoptionaltyping.List[str]availabilityZonesoptionalList<String>AvailabilityZonesoptionalstring[]AvailabilityZonesoptional*[]*string#
The Availability Zones for a load balancer in a default VPC.
notes

For a load balancer in a nondefault 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.

connectionDrainingPolicyoptionalIResolvable | CfnLoadBalancer.ConnectionDrainingPolicyPropertyconnection_draining_policyoptionaltyping.Union[IResolvable, ConnectionDrainingPolicyProperty]connectionDrainingPolicyoptionalIResolvableConnectionDrainingPolicyoptionalIResolvableConnectionDrainingPolicyoptionalinterface{}#
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 User Guide for Classic Load Balancers .

connectionSettingsoptionalIResolvable | CfnLoadBalancer.ConnectionSettingsPropertyconnection_settingsoptionaltyping.Union[IResolvable, ConnectionSettingsProperty]connectionSettingsoptionalIResolvableConnectionSettingsoptionalIResolvableConnectionSettingsoptionalinterface{}#
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
notes

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 User Guide for Classic Load Balancers .

crossZoneoptionalboolean | IResolvablecross_zoneoptionaltyping.Union[bool, IResolvable]crossZoneoptionalBooleanCrossZoneoptionalboolCrossZoneoptionalinterface{}#
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 User Guide for Classic Load Balancers .

healthCheckoptionalIResolvable | CfnLoadBalancer.HealthCheckPropertyhealth_checkoptionaltyping.Union[IResolvable, HealthCheckProperty]healthCheckoptionalIResolvableHealthCheckoptionalIResolvableHealthCheckoptionalinterface{}#
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.

instancesoptionalstring | IInstanceRef[]instancesoptionaltyping.List[typing.Union[str, IInstanceRef]]instancesoptionalList<String>Instancesoptionalstring[]Instancesoptional*[]interface{}#
The IDs of the instances for the load balancer.
lbCookieStickinessPolicyoptionalIResolvable | IResolvable | CfnLoadBalancer.LBCookieStickinessPolicyProperty[]lb_cookie_stickiness_policyoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LBCookieStickinessPolicyProperty]]]lbCookieStickinessPolicyoptionalIResolvableLbCookieStickinessPolicyoptionalIResolvableLbCookieStickinessPolicyoptionalinterface{}#
Information about a policy for duration-based session stickiness.
listenersIResolvable | IResolvable | CfnLoadBalancer.ListenersProperty[]listenerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ListenersProperty]]]listenersIResolvableListenersIResolvableListenersinterface{}required#
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.

loadBalancerNameoptionalstringload_balancer_nameoptionalstrloadBalancerNameoptionalStringLoadBalancerNameoptionalstringLoadBalancerNameoptional*string#
The name of the load balancer.
notes

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.

policiesoptionalIResolvable | IResolvable | CfnLoadBalancer.PoliciesProperty[]policiesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PoliciesProperty]]]policiesoptionalIResolvablePoliciesoptionalIResolvablePoliciesoptionalinterface{}#
The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

schemeoptionalstringschemeoptionalstrschemeoptionalStringSchemeoptionalstringSchemeoptional*string#
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.

securityGroupsoptionalstring | ISecurityGroupRef[]security_groupsoptionaltyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupsoptionalList<String>SecurityGroupsoptionalstring[]SecurityGroupsoptional*[]interface{}#
The security groups for the load balancer.

Valid only for load balancers in a VPC.

subnetsoptionalstring | ISubnetRef[]subnetsoptionaltyping.List[typing.Union[str, ISubnetRef]]subnetsoptionalList<String>Subnetsoptionalstring[]Subnetsoptional*[]interface{}#
The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone.
notes

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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags associated with a load balancer.