software.amazon.awscdk.services.elasticloadbalancing

Class CfnLoadBalancer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticloadbalancing.CfnLoadBalancer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.499Z")
 @Stability(value=Stable)
public class CfnLoadBalancer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElasticLoadBalancing::LoadBalancer`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnLoadBalancer.AccessLoggingPolicyProperty Example:
static interface	CfnLoadBalancer.AppCookieStickinessPolicyProperty Example:
static class	CfnLoadBalancer.Builder A fluent builder for CfnLoadBalancer.
static interface	CfnLoadBalancer.ConnectionDrainingPolicyProperty Example:
static interface	CfnLoadBalancer.ConnectionSettingsProperty Example:
static interface	CfnLoadBalancer.HealthCheckProperty Example:
static interface	CfnLoadBalancer.LBCookieStickinessPolicyProperty Example:
static interface	CfnLoadBalancer.ListenersProperty Example:
static interface	CfnLoadBalancer.PoliciesProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLoadBalancer(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
Object	getAccessLoggingPolicy() `AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.
Object	getAppCookieStickinessPolicy() `AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.
String	getAttrCanonicalHostedZoneName()
String	getAttrCanonicalHostedZoneNameId()
String	getAttrDnsName()
String	getAttrSourceSecurityGroupGroupName()
String	getAttrSourceSecurityGroupOwnerAlias()
List<String>	getAvailabilityZones() `AWS::ElasticLoadBalancing::LoadBalancer.AvailabilityZones`.
protected Map<String,Object>	getCfnProperties()
Object	getConnectionDrainingPolicy() `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.
Object	getConnectionSettings() `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.
Object	getCrossZone() `AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.
Object	getHealthCheck() `AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.
List<String>	getInstances() `AWS::ElasticLoadBalancing::LoadBalancer.Instances`.
Object	getLbCookieStickinessPolicy() `AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.
Object	getListeners() `AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.
String	getLoadBalancerName() `AWS::ElasticLoadBalancing::LoadBalancer.LoadBalancerName`.
Object	getPolicies() `AWS::ElasticLoadBalancing::LoadBalancer.Policies`.
String	getScheme() `AWS::ElasticLoadBalancing::LoadBalancer.Scheme`.
List<String>	getSecurityGroups() `AWS::ElasticLoadBalancing::LoadBalancer.SecurityGroups`.
List<String>	getSubnets() `AWS::ElasticLoadBalancing::LoadBalancer.Subnets`.
TagManager	getTags() `AWS::ElasticLoadBalancing::LoadBalancer.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessLoggingPolicy(CfnLoadBalancer.AccessLoggingPolicyProperty value) `AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.
void	setAccessLoggingPolicy(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.
void	setAppCookieStickinessPolicy(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.
void	setAppCookieStickinessPolicy(List<Object> value) `AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.
void	setAvailabilityZones(List<String> value) `AWS::ElasticLoadBalancing::LoadBalancer.AvailabilityZones`.
void	setConnectionDrainingPolicy(CfnLoadBalancer.ConnectionDrainingPolicyProperty value) `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.
void	setConnectionDrainingPolicy(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.
void	setConnectionSettings(CfnLoadBalancer.ConnectionSettingsProperty value) `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.
void	setConnectionSettings(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.
void	setCrossZone(Boolean value) `AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.
void	setCrossZone(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.
void	setHealthCheck(CfnLoadBalancer.HealthCheckProperty value) `AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.
void	setHealthCheck(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.
void	setInstances(List<String> value) `AWS::ElasticLoadBalancing::LoadBalancer.Instances`.
void	setLbCookieStickinessPolicy(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.
void	setLbCookieStickinessPolicy(List<Object> value) `AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.
void	setListeners(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.
void	setListeners(List<Object> value) `AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.
void	setLoadBalancerName(String value) `AWS::ElasticLoadBalancing::LoadBalancer.LoadBalancerName`.
void	setPolicies(IResolvable value) `AWS::ElasticLoadBalancing::LoadBalancer.Policies`.
void	setPolicies(List<Object> value) `AWS::ElasticLoadBalancing::LoadBalancer.Policies`.
void	setScheme(String value) `AWS::ElasticLoadBalancing::LoadBalancer.Scheme`.
void	setSecurityGroups(List<String> value) `AWS::ElasticLoadBalancing::LoadBalancer.SecurityGroups`.
void	setSubnets(List<String> value) `AWS::ElasticLoadBalancing::LoadBalancer.Subnets`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLoadBalancer

protected CfnLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)

CfnLoadBalancer

protected CfnLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLoadBalancer

@Stability(value=Stable)
public CfnLoadBalancer(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnLoadBalancerProps props)

Create a new `AWS::ElasticLoadBalancing::LoadBalancer`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAccessLoggingPolicy

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

`AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.

setAccessLoggingPolicy

@Stability(value=Stable)
public void setAccessLoggingPolicy(@Nullable
                                                            CfnLoadBalancer.AccessLoggingPolicyProperty value)

`AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.

setAccessLoggingPolicy

@Stability(value=Stable)
public void setAccessLoggingPolicy(@Nullable
                                                            IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy`.

getAppCookieStickinessPolicy

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

`AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.

setAppCookieStickinessPolicy

@Stability(value=Stable)
public void setAppCookieStickinessPolicy(@Nullable
                                                                  IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.

setAppCookieStickinessPolicy

@Stability(value=Stable)
public void setAppCookieStickinessPolicy(@Nullable
                                                                  List<Object> value)

`AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy`.

getAttrCanonicalHostedZoneName

@Stability(value=Stable)
 @NotNull
public String getAttrCanonicalHostedZoneName()

getAttrCanonicalHostedZoneNameId

@Stability(value=Stable)
 @NotNull
public String getAttrCanonicalHostedZoneNameId()

getAttrDnsName

@Stability(value=Stable)
 @NotNull
public String getAttrDnsName()

getAttrSourceSecurityGroupGroupName

@Stability(value=Stable)
 @NotNull
public String getAttrSourceSecurityGroupGroupName()

getAttrSourceSecurityGroupOwnerAlias

@Stability(value=Stable)
 @NotNull
public String getAttrSourceSecurityGroupOwnerAlias()

getAvailabilityZones

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

`AWS::ElasticLoadBalancing::LoadBalancer.AvailabilityZones`.

setAvailabilityZones

@Stability(value=Stable)
public void setAvailabilityZones(@Nullable
                                                          List<String> value)

`AWS::ElasticLoadBalancing::LoadBalancer.AvailabilityZones`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionDrainingPolicy

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

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.

setConnectionDrainingPolicy

@Stability(value=Stable)
public void setConnectionDrainingPolicy(@Nullable
                                                                 CfnLoadBalancer.ConnectionDrainingPolicyProperty value)

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.

setConnectionDrainingPolicy

@Stability(value=Stable)
public void setConnectionDrainingPolicy(@Nullable
                                                                 IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy`.

getConnectionSettings

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

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.

setConnectionSettings

@Stability(value=Stable)
public void setConnectionSettings(@Nullable
                                                           CfnLoadBalancer.ConnectionSettingsProperty value)

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.

setConnectionSettings

@Stability(value=Stable)
public void setConnectionSettings(@Nullable
                                                           IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings`.

getCrossZone

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

`AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.

setCrossZone

@Stability(value=Stable)
public void setCrossZone(@Nullable
                                                  Boolean value)

`AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.

setCrossZone

@Stability(value=Stable)
public void setCrossZone(@Nullable
                                                  IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.CrossZone`.

getHealthCheck

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

`AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.

setHealthCheck

@Stability(value=Stable)
public void setHealthCheck(@Nullable
                                                    CfnLoadBalancer.HealthCheckProperty value)

`AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.

setHealthCheck

@Stability(value=Stable)
public void setHealthCheck(@Nullable
                                                    IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck`.

getInstances

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

`AWS::ElasticLoadBalancing::LoadBalancer.Instances`.

setInstances

@Stability(value=Stable)
public void setInstances(@Nullable
                                                  List<String> value)

`AWS::ElasticLoadBalancing::LoadBalancer.Instances`.

getLbCookieStickinessPolicy

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

`AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.

setLbCookieStickinessPolicy

@Stability(value=Stable)
public void setLbCookieStickinessPolicy(@Nullable
                                                                 IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.

setLbCookieStickinessPolicy

@Stability(value=Stable)
public void setLbCookieStickinessPolicy(@Nullable
                                                                 List<Object> value)

`AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy`.

getListeners

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

`AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.

setListeners

@Stability(value=Stable)
public void setListeners(@NotNull
                                                  IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.

setListeners

@Stability(value=Stable)
public void setListeners(@NotNull
                                                  List<Object> value)

`AWS::ElasticLoadBalancing::LoadBalancer.Listeners`.

getLoadBalancerName

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

`AWS::ElasticLoadBalancing::LoadBalancer.LoadBalancerName`.

setLoadBalancerName

@Stability(value=Stable)
public void setLoadBalancerName(@Nullable
                                                         String value)

`AWS::ElasticLoadBalancing::LoadBalancer.LoadBalancerName`.

getPolicies

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

`AWS::ElasticLoadBalancing::LoadBalancer.Policies`.

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 IResolvable value)

`AWS::ElasticLoadBalancing::LoadBalancer.Policies`.

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 List<Object> value)

`AWS::ElasticLoadBalancing::LoadBalancer.Policies`.

getScheme

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

`AWS::ElasticLoadBalancing::LoadBalancer.Scheme`.

setScheme

@Stability(value=Stable)
public void setScheme(@Nullable
                                               String value)

`AWS::ElasticLoadBalancing::LoadBalancer.Scheme`.

getSecurityGroups

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

`AWS::ElasticLoadBalancing::LoadBalancer.SecurityGroups`.

setSecurityGroups

@Stability(value=Stable)
public void setSecurityGroups(@Nullable
                                                       List<String> value)

`AWS::ElasticLoadBalancing::LoadBalancer.SecurityGroups`.

getSubnets

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

`AWS::ElasticLoadBalancing::LoadBalancer.Subnets`.

setSubnets

@Stability(value=Stable)
public void setSubnets(@Nullable
                                                List<String> value)

`AWS::ElasticLoadBalancing::LoadBalancer.Subnets`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ElasticLoadBalancing::LoadBalancer.Tags`.