software.amazon.awscdk.services.elasticloadbalancing

Interface CfnLoadBalancerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.032Z")
 @Stability(value=Stable)
public interface CfnLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLoadBalancer`.

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLoadBalancerProps.Builder A builder for CfnLoadBalancerProps
static class	CfnLoadBalancerProps.Jsii$Proxy An implementation for CfnLoadBalancerProps

Method Summary

Modifier and Type	Method and Description
static CfnLoadBalancerProps.Builder	builder()
default Object	getAccessLoggingPolicy() Information about where and how access logs are stored for the load balancer.
default Object	getAppCookieStickinessPolicy() Information about a policy for application-controlled session stickiness.
default List<String>	getAvailabilityZones() The Availability Zones for the load balancer.
default Object	getConnectionDrainingPolicy() If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
default Object	getConnectionSettings() If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
default Object	getCrossZone() If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
default Object	getHealthCheck() The health check settings to use when evaluating the health of your EC2 instances.
default List<String>	getInstances() The IDs of the instances for the load balancer.
default Object	getLbCookieStickinessPolicy() Information about a policy for duration-based session stickiness.
Object	getListeners() The listeners for the load balancer.
default String	getLoadBalancerName() The name of the load balancer.
default Object	getPolicies() The policies defined for your Classic Load Balancer.
default String	getScheme() The type of load balancer.
default List<String>	getSecurityGroups() The security groups for the load balancer.
default List<String>	getSubnets() The IDs of the subnets for the load balancer.
default List<CfnTag>	getTags() The tags associated with a load balancer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getListeners

@Stability(value=Stable)
 @NotNull
Object getListeners()

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.

getAccessLoggingPolicy

@Stability(value=Stable)
 @Nullable
default Object getAccessLoggingPolicy()

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

getAppCookieStickinessPolicy

@Stability(value=Stable)
 @Nullable
default Object getAppCookieStickinessPolicy()

Information about a policy for application-controlled session stickiness.

getAvailabilityZones

@Stability(value=Stable)
 @Nullable
default List<String> getAvailabilityZones()

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.

getConnectionDrainingPolicy

@Stability(value=Stable)
 @Nullable
default Object getConnectionDrainingPolicy()

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 .

getConnectionSettings

@Stability(value=Stable)
 @Nullable
default Object getConnectionSettings()

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 .

getCrossZone

@Stability(value=Stable)
 @Nullable
default Object getCrossZone()

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 .

getHealthCheck

@Stability(value=Stable)
 @Nullable
default Object getHealthCheck()

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.

getInstances

@Stability(value=Stable)
 @Nullable
default List<String> getInstances()

The IDs of the instances for the load balancer.

getLbCookieStickinessPolicy

@Stability(value=Stable)
 @Nullable
default Object getLbCookieStickinessPolicy()

Information about a policy for duration-based session stickiness.

getLoadBalancerName

@Stability(value=Stable)
 @Nullable
default String getLoadBalancerName()

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.

getPolicies

@Stability(value=Stable)
 @Nullable
default Object getPolicies()

The policies defined for your Classic Load Balancer.

Specify only back-end server policies.

getScheme

@Stability(value=Stable)
 @Nullable
default String getScheme()

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.

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroups()

The security groups for the load balancer.

Valid only for load balancers in a VPC.

getSubnets

@Stability(value=Stable)
 @Nullable
default List<String> getSubnets()

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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The tags associated with a load balancer.

builder

@Stability(value=Stable)
static CfnLoadBalancerProps.Builder builder()

Returns:

a CfnLoadBalancerProps.Builder of CfnLoadBalancerProps