@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-09T19:16:38.243Z") public class CfnLoadBalancer extends CfnResource implements IInspectable
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 software.amazon.awscdk.services.elasticloadbalancing.*; Object attributes; CfnLoadBalancer cfnLoadBalancer = CfnLoadBalancer.Builder.create(this, "MyCfnLoadBalancer") .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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnLoadBalancer.AccessLoggingPolicyProperty
Specifies where and how access logs are stored for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.AppCookieStickinessPolicyProperty
Specifies a policy for application-controlled session stickiness for your Classic Load Balancer.
|
static class |
CfnLoadBalancer.Builder
A fluent builder for
CfnLoadBalancer . |
static interface |
CfnLoadBalancer.ConnectionDrainingPolicyProperty
Specifies the connection draining settings for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.ConnectionSettingsProperty
Specifies the idle timeout value for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.HealthCheckProperty
Specifies health check settings for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.LBCookieStickinessPolicyProperty
Specifies a policy for duration-based session stickiness for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.ListenersProperty
Specifies a listener for your Classic Load Balancer.
|
static interface |
CfnLoadBalancer.PoliciesProperty
Specifies policies for your Classic Load Balancer.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnLoadBalancer(Construct scope,
java.lang.String id,
CfnLoadBalancerProps props)
Create a new `AWS::ElasticLoadBalancing::LoadBalancer`.
|
protected |
CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAccessLoggingPolicy()
Information about where and how access logs are stored for the load balancer.
|
java.lang.Object |
getAppCookieStickinessPolicy()
Information about a policy for application-controlled session stickiness.
|
java.lang.String |
getAttrCanonicalHostedZoneName()
The name of the Route 53 hosted zone that is associated with the load balancer.
|
java.lang.String |
getAttrCanonicalHostedZoneNameId()
The ID of the Route 53 hosted zone name that is associated with the load balancer.
|
java.lang.String |
getAttrDnsName()
The DNS name for the load balancer.
|
java.lang.String |
getAttrSourceSecurityGroupGroupName()
The name of the security group that you can use as part of your inbound rules for your load balancer's back-end instances.
|
java.lang.String |
getAttrSourceSecurityGroupOwnerAlias()
The owner of the source security group.
|
java.util.List<java.lang.String> |
getAvailabilityZones()
The Availability Zones for the load balancer.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.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.
|
java.lang.Object |
getConnectionSettings()
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
|
java.lang.Object |
getCrossZone()
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
|
java.lang.Object |
getHealthCheck()
The health check settings to use when evaluating the health of your EC2 instances.
|
java.util.List<java.lang.String> |
getInstances()
The IDs of the instances for the load balancer.
|
java.lang.Object |
getLbCookieStickinessPolicy()
Information about a policy for duration-based session stickiness.
|
java.lang.Object |
getListeners()
The listeners for the load balancer.
|
java.lang.String |
getLoadBalancerName()
The name of the load balancer.
|
java.lang.Object |
getPolicies()
The policies defined for your Classic Load Balancer.
|
java.lang.String |
getScheme()
The type of load balancer.
|
java.util.List<java.lang.String> |
getSecurityGroups()
The security groups for the load balancer.
|
java.util.List<java.lang.String> |
getSubnets()
The IDs of the subnets for the load balancer.
|
TagManager |
getTags()
The tags associated with a load balancer.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAccessLoggingPolicy(CfnLoadBalancer.AccessLoggingPolicyProperty value)
Information about where and how access logs are stored for the load balancer.
|
void |
setAccessLoggingPolicy(IResolvable value)
Information about where and how access logs are stored for the load balancer.
|
void |
setAppCookieStickinessPolicy(IResolvable value)
Information about a policy for application-controlled session stickiness.
|
void |
setAppCookieStickinessPolicy(java.util.List<java.lang.Object> value)
Information about a policy for application-controlled session stickiness.
|
void |
setAvailabilityZones(java.util.List<java.lang.String> value)
The Availability Zones for the load balancer.
|
void |
setConnectionDrainingPolicy(CfnLoadBalancer.ConnectionDrainingPolicyProperty value)
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
|
void |
setConnectionDrainingPolicy(IResolvable value)
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
|
void |
setConnectionSettings(CfnLoadBalancer.ConnectionSettingsProperty value)
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
|
void |
setConnectionSettings(IResolvable value)
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
|
void |
setCrossZone(java.lang.Boolean value)
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
|
void |
setCrossZone(IResolvable value)
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
|
void |
setHealthCheck(CfnLoadBalancer.HealthCheckProperty value)
The health check settings to use when evaluating the health of your EC2 instances.
|
void |
setHealthCheck(IResolvable value)
The health check settings to use when evaluating the health of your EC2 instances.
|
void |
setInstances(java.util.List<java.lang.String> value)
The IDs of the instances for the load balancer.
|
void |
setLbCookieStickinessPolicy(IResolvable value)
Information about a policy for duration-based session stickiness.
|
void |
setLbCookieStickinessPolicy(java.util.List<java.lang.Object> value)
Information about a policy for duration-based session stickiness.
|
void |
setListeners(IResolvable value)
The listeners for the load balancer.
|
void |
setListeners(java.util.List<java.lang.Object> value)
The listeners for the load balancer.
|
void |
setLoadBalancerName(java.lang.String value)
The name of the load balancer.
|
void |
setPolicies(IResolvable value)
The policies defined for your Classic Load Balancer.
|
void |
setPolicies(java.util.List<java.lang.Object> value)
The policies defined for your Classic Load Balancer.
|
void |
setScheme(java.lang.String value)
The type of load balancer.
|
void |
setSecurityGroups(java.util.List<java.lang.String> value)
The security groups for the load balancer.
|
void |
setSubnets(java.util.List<java.lang.String> value)
The IDs of the subnets for the load balancer.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLoadBalancer(Construct scope, java.lang.String id, CfnLoadBalancerProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrCanonicalHostedZoneName()
Internal-facing load balancers don't use this value, use DNSName
instead.
public java.lang.String getAttrCanonicalHostedZoneNameId()
public java.lang.String getAttrDnsName()
public java.lang.String getAttrSourceSecurityGroupGroupName()
public java.lang.String getAttrSourceSecurityGroupOwnerAlias()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getListeners()
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.
public void setListeners(IResolvable value)
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.
public void setListeners(java.util.List<java.lang.Object> value)
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.
public java.lang.Object getAccessLoggingPolicy()
public void setAccessLoggingPolicy(IResolvable value)
public void setAccessLoggingPolicy(CfnLoadBalancer.AccessLoggingPolicyProperty value)
public java.lang.Object getAppCookieStickinessPolicy()
public void setAppCookieStickinessPolicy(IResolvable value)
public void setAppCookieStickinessPolicy(java.util.List<java.lang.Object> value)
public java.util.List<java.lang.String> getAvailabilityZones()
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.
public void setAvailabilityZones(java.util.List<java.lang.String> value)
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.
public java.lang.Object getConnectionDrainingPolicy()
For more information, see Configure Connection Draining in the Classic Load Balancers Guide .
public void setConnectionDrainingPolicy(IResolvable value)
For more information, see Configure Connection Draining in the Classic Load Balancers Guide .
public void setConnectionDrainingPolicy(CfnLoadBalancer.ConnectionDrainingPolicyProperty value)
For more information, see Configure Connection Draining in the Classic Load Balancers Guide .
public java.lang.Object getConnectionSettings()
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 .
public void setConnectionSettings(IResolvable value)
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 .
public void setConnectionSettings(CfnLoadBalancer.ConnectionSettingsProperty value)
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 .
public java.lang.Object getCrossZone()
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide .
public void setCrossZone(java.lang.Boolean value)
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide .
public void setCrossZone(IResolvable value)
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide .
public java.lang.Object getHealthCheck()
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.
public void setHealthCheck(IResolvable value)
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.
public void setHealthCheck(CfnLoadBalancer.HealthCheckProperty value)
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.
public java.util.List<java.lang.String> getInstances()
public void setInstances(java.util.List<java.lang.String> value)
public java.lang.Object getLbCookieStickinessPolicy()
public void setLbCookieStickinessPolicy(IResolvable value)
public void setLbCookieStickinessPolicy(java.util.List<java.lang.Object> value)
public java.lang.String getLoadBalancerName()
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.
public void setLoadBalancerName(java.lang.String value)
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.
public java.lang.Object getPolicies()
Specify only back-end server policies.
public void setPolicies(IResolvable value)
Specify only back-end server policies.
public void setPolicies(java.util.List<java.lang.Object> value)
Specify only back-end server policies.
public java.lang.String getScheme()
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.
public void setScheme(java.lang.String value)
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.
public java.util.List<java.lang.String> getSecurityGroups()
Valid only for load balancers in a VPC.
public void setSecurityGroups(java.util.List<java.lang.String> value)
Valid only for load balancers in a VPC.
public java.util.List<java.lang.String> getSubnets()
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.
public void setSubnets(java.util.List<java.lang.String> value)
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.