Package software.amazon.awscdk.services.elasticloadbalancingv2

Class BaseLoadBalancer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancer

All Implemented Interfaces:

IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

ApplicationLoadBalancer, NetworkLoadBalancer

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:41.537Z")
@Stability(Stable)
public abstract class BaseLoadBalancer
extends Resource

Base class for both Application and Network Load Balancers.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BaseLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)
protected	BaseLoadBalancer(software.constructs.Construct scope, String id, BaseLoadBalancerProps baseProps, Object additionalProps)

Method Summary

Modifier and Type	Method	Description
String	getLoadBalancerArn()	The ARN of this load balancer.
String	getLoadBalancerCanonicalHostedZoneId()	The canonical hosted zone ID of this load balancer.
String	getLoadBalancerDnsName()	The DNS name of this load balancer.
String	getLoadBalancerFullName()	The full name of this load balancer.
String	getLoadBalancerName()	The name of this load balancer.
List<String>	getLoadBalancerSecurityGroups()
IVpc	getVpc()	The VPC this load balancer has been created in.
void	logAccessLogs(IBucket bucket)	Enable access logging for this load balancer.
void	logAccessLogs(IBucket bucket, String prefix)	Enable access logging for this load balancer.
void	removeAttribute(String key)	Remove an attribute from the load balancer.
protected IPrincipal	resourcePolicyPrincipal()
void	setAttribute(String key)	Set a non-standard attribute on the load balancer.
void	setAttribute(String key, String value)	Set a non-standard attribute on the load balancer.
protected List<String>	validateLoadBalancer()

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BaseLoadBalancer

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

BaseLoadBalancer

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

BaseLoadBalancer

@Stability(Stable)
protected BaseLoadBalancer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BaseLoadBalancerProps baseProps,
 @NotNull
 Object additionalProps)

Parameters:

scope - This parameter is required.

id - This parameter is required.

baseProps - This parameter is required.

additionalProps - This parameter is required.

Method Details

logAccessLogs

@Stability(Stable)
public void logAccessLogs(@NotNull
 IBucket bucket,
 @Nullable
 String prefix)

Enable access logging for this load balancer.

A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html

Parameters:

bucket - This parameter is required.

prefix -

logAccessLogs

@Stability(Stable)
public void logAccessLogs(@NotNull
 IBucket bucket)

Enable access logging for this load balancer.

A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html

Parameters:

bucket - This parameter is required.

removeAttribute

@Stability(Stable)
public void removeAttribute(@NotNull
 String key)

Remove an attribute from the load balancer.

Parameters:

key - This parameter is required.

resourcePolicyPrincipal

@Stability(Stable)
@NotNull
protected IPrincipal resourcePolicyPrincipal()

setAttribute

@Stability(Stable)
public void setAttribute(@NotNull
 String key,
 @Nullable
 String value)

Set a non-standard attribute on the load balancer.

Parameters:

key - This parameter is required.

value -

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes

setAttribute

@Stability(Stable)
public void setAttribute(@NotNull
 String key)

Set a non-standard attribute on the load balancer.

Parameters:

key - This parameter is required.

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes

validateLoadBalancer

@Stability(Stable)
@NotNull
protected List<String> validateLoadBalancer()

getLoadBalancerArn

@Stability(Stable)
@NotNull
public String getLoadBalancerArn()

The ARN of this load balancer.

Example value: arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188

getLoadBalancerCanonicalHostedZoneId

@Stability(Stable)
@NotNull
public String getLoadBalancerCanonicalHostedZoneId()

The canonical hosted zone ID of this load balancer.

Example value: Z2P70J7EXAMPLE

getLoadBalancerDnsName

@Stability(Stable)
@NotNull
public String getLoadBalancerDnsName()

The DNS name of this load balancer.

Example value: my-load-balancer-424835706.us-west-2.elb.amazonaws.com

getLoadBalancerFullName

@Stability(Stable)
@NotNull
public String getLoadBalancerFullName()

The full name of this load balancer.

Example value: app/my-load-balancer/50dc6c495c0c9188

getLoadBalancerName

@Stability(Stable)
@NotNull
public String getLoadBalancerName()

The name of this load balancer.

Example value: my-load-balancer

getLoadBalancerSecurityGroups

@Stability(Stable)
@NotNull
public List<String> getLoadBalancerSecurityGroups()

getVpc

@Stability(Stable)
@Nullable
public IVpc getVpc()

The VPC this load balancer has been created in.

This property is always defined (not null or undefined) for sub-classes of BaseLoadBalancer.