Package software.amazon.awscdk.services.elasticloadbalancing

Class CfnLoadBalancer.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancing.CfnLoadBalancer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLoadBalancer>

Enclosing class:

CfnLoadBalancer

@Stability(Stable)
public static final class CfnLoadBalancer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLoadBalancer>

A fluent builder for CfnLoadBalancer.

Method Summary

Modifier and Type	Method	Description
CfnLoadBalancer.Builder	accessLoggingPolicy(IResolvable accessLoggingPolicy)	Information about where and how access logs are stored for the load balancer.
CfnLoadBalancer.Builder	accessLoggingPolicy(CfnLoadBalancer.AccessLoggingPolicyProperty accessLoggingPolicy)	Information about where and how access logs are stored for the load balancer.
CfnLoadBalancer.Builder	appCookieStickinessPolicy(List<? extends Object> appCookieStickinessPolicy)	Information about a policy for application-controlled session stickiness.
CfnLoadBalancer.Builder	appCookieStickinessPolicy(IResolvable appCookieStickinessPolicy)	Information about a policy for application-controlled session stickiness.
CfnLoadBalancer.Builder	availabilityZones(List<String> availabilityZones)	The Availability Zones for a load balancer in a default VPC.
CfnLoadBalancer	build()
CfnLoadBalancer.Builder	connectionDrainingPolicy(IResolvable connectionDrainingPolicy)	If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
CfnLoadBalancer.Builder	connectionDrainingPolicy(CfnLoadBalancer.ConnectionDrainingPolicyProperty connectionDrainingPolicy)	If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
CfnLoadBalancer.Builder	connectionSettings(IResolvable connectionSettings)	If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
CfnLoadBalancer.Builder	connectionSettings(CfnLoadBalancer.ConnectionSettingsProperty connectionSettings)	If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
static CfnLoadBalancer.Builder	create(software.constructs.Construct scope, String id)
CfnLoadBalancer.Builder	crossZone(Boolean crossZone)	If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
CfnLoadBalancer.Builder	crossZone(IResolvable crossZone)	If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
CfnLoadBalancer.Builder	healthCheck(IResolvable healthCheck)	The health check settings to use when evaluating the health of your EC2 instances.
CfnLoadBalancer.Builder	healthCheck(CfnLoadBalancer.HealthCheckProperty healthCheck)	The health check settings to use when evaluating the health of your EC2 instances.
CfnLoadBalancer.Builder	instances(List<String> instances)	The IDs of the instances for the load balancer.
CfnLoadBalancer.Builder	lbCookieStickinessPolicy(List<? extends Object> lbCookieStickinessPolicy)	Information about a policy for duration-based session stickiness.
CfnLoadBalancer.Builder	lbCookieStickinessPolicy(IResolvable lbCookieStickinessPolicy)	Information about a policy for duration-based session stickiness.
CfnLoadBalancer.Builder	listeners(List<? extends Object> listeners)	The listeners for the load balancer.
CfnLoadBalancer.Builder	listeners(IResolvable listeners)	The listeners for the load balancer.
CfnLoadBalancer.Builder	loadBalancerName(String loadBalancerName)	The name of the load balancer.
CfnLoadBalancer.Builder	policies(List<? extends Object> policies)	The policies defined for your Classic Load Balancer.
CfnLoadBalancer.Builder	policies(IResolvable policies)	The policies defined for your Classic Load Balancer.
CfnLoadBalancer.Builder	scheme(String scheme)	The type of load balancer.
CfnLoadBalancer.Builder	securityGroups(List<String> securityGroups)	The security groups for the load balancer.
CfnLoadBalancer.Builder	subnets(List<String> subnets)	The IDs of the subnets for the load balancer.
CfnLoadBalancer.Builder	tags(List<? extends CfnTag> tags)	The tags associated with a load balancer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLoadBalancer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLoadBalancer.Builder.

listeners

@Stability(Stable)
public CfnLoadBalancer.Builder listeners(IResolvable listeners)

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.

Parameters:

listeners - The listeners for the load balancer. You can specify at most one listener per port. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-listeners

listeners

@Stability(Stable)
public CfnLoadBalancer.Builder listeners(List<? extends Object> listeners)

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.

Parameters:

listeners - The listeners for the load balancer. You can specify at most one listener per port. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-listeners

accessLoggingPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder accessLoggingPolicy(IResolvable accessLoggingPolicy)

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

Parameters:

accessLoggingPolicy - Information about where and how access logs are stored for the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-accessloggingpolicy

accessLoggingPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder accessLoggingPolicy(CfnLoadBalancer.AccessLoggingPolicyProperty accessLoggingPolicy)

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

Parameters:

accessLoggingPolicy - Information about where and how access logs are stored for the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-accessloggingpolicy

appCookieStickinessPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder appCookieStickinessPolicy(IResolvable appCookieStickinessPolicy)

Information about a policy for application-controlled session stickiness.

Parameters:

appCookieStickinessPolicy - Information about a policy for application-controlled session stickiness. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-appcookiestickinesspolicy

appCookieStickinessPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder appCookieStickinessPolicy(List<? extends Object> appCookieStickinessPolicy)

Information about a policy for application-controlled session stickiness.

Parameters:

appCookieStickinessPolicy - Information about a policy for application-controlled session stickiness. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-appcookiestickinesspolicy

availabilityZones

@Stability(Stable)
public CfnLoadBalancer.Builder availabilityZones(List<String> availabilityZones)

The Availability Zones for a load balancer in a default VPC.

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.

Parameters:

availabilityZones - The Availability Zones for a load balancer in a default VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-availabilityzones

connectionDrainingPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder connectionDrainingPolicy(IResolvable connectionDrainingPolicy)

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 .

Parameters:

connectionDrainingPolicy - If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-connectiondrainingpolicy

connectionDrainingPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder connectionDrainingPolicy(CfnLoadBalancer.ConnectionDrainingPolicyProperty connectionDrainingPolicy)

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 .

Parameters:

connectionDrainingPolicy - If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-connectiondrainingpolicy

connectionSettings

@Stability(Stable)
public CfnLoadBalancer.Builder connectionSettings(IResolvable connectionSettings)

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

Parameters:

connectionSettings - If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-connectionsettings

connectionSettings

@Stability(Stable)
public CfnLoadBalancer.Builder connectionSettings(CfnLoadBalancer.ConnectionSettingsProperty connectionSettings)

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

Parameters:

connectionSettings - If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-connectionsettings

crossZone

@Stability(Stable)
public CfnLoadBalancer.Builder crossZone(Boolean crossZone)

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 .

Parameters:

crossZone - If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-crosszone

crossZone

@Stability(Stable)
public CfnLoadBalancer.Builder crossZone(IResolvable crossZone)

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 .

Parameters:

crossZone - If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-crosszone

healthCheck

@Stability(Stable)
public CfnLoadBalancer.Builder healthCheck(IResolvable healthCheck)

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.

Parameters:

healthCheck - The health check settings to use when evaluating the health of your EC2 instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-healthcheck

healthCheck

@Stability(Stable)
public CfnLoadBalancer.Builder healthCheck(CfnLoadBalancer.HealthCheckProperty healthCheck)

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.

Parameters:

healthCheck - The health check settings to use when evaluating the health of your EC2 instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-healthcheck

instances

@Stability(Stable)
public CfnLoadBalancer.Builder instances(List<String> instances)

The IDs of the instances for the load balancer.

Parameters:

instances - The IDs of the instances for the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-instances

lbCookieStickinessPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder lbCookieStickinessPolicy(IResolvable lbCookieStickinessPolicy)

Information about a policy for duration-based session stickiness.

Parameters:

lbCookieStickinessPolicy - Information about a policy for duration-based session stickiness. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy

lbCookieStickinessPolicy

@Stability(Stable)
public CfnLoadBalancer.Builder lbCookieStickinessPolicy(List<? extends Object> lbCookieStickinessPolicy)

Information about a policy for duration-based session stickiness.

Parameters:

lbCookieStickinessPolicy - Information about a policy for duration-based session stickiness. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy

loadBalancerName

@Stability(Stable)
public CfnLoadBalancer.Builder loadBalancerName(String loadBalancerName)

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.

Parameters:

loadBalancerName - The name of the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-loadbalancername

policies

@Stability(Stable)
public CfnLoadBalancer.Builder policies(IResolvable policies)

The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

Parameters:

policies - The policies defined for your Classic Load Balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-policies

policies

@Stability(Stable)
public CfnLoadBalancer.Builder policies(List<? extends Object> policies)

The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

Parameters:

policies - The policies defined for your Classic Load Balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-policies

scheme

@Stability(Stable)
public CfnLoadBalancer.Builder scheme(String scheme)

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.

Parameters:

scheme - The type of load balancer. Valid only for load balancers in a VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-scheme

securityGroups

@Stability(Stable)
public CfnLoadBalancer.Builder securityGroups(List<String> securityGroups)

The security groups for the load balancer.

Valid only for load balancers in a VPC.

Parameters:

securityGroups - The security groups for the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-securitygroups

subnets

@Stability(Stable)
public CfnLoadBalancer.Builder subnets(List<String> subnets)

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.

Parameters:

subnets - The IDs of the subnets for the load balancer. You can specify at most one subnet per Availability Zone. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-subnets

tags

@Stability(Stable)
public CfnLoadBalancer.Builder tags(List<? extends CfnTag> tags)

The tags associated with a load balancer.

Parameters:

tags - The tags associated with a load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancing-loadbalancer.html#cfn-elasticloadbalancing-loadbalancer-tags

build

@Stability(Stable)
public CfnLoadBalancer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLoadBalancer>

Returns:

a newly built instance of CfnLoadBalancer.