Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface IApplicationLoadBalancer

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, ILoadBalancerV2, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApplicationLoadBalancer.Jsii$Default

All Known Implementing Classes:

ApplicationLoadBalancer, IApplicationLoadBalancer.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:19.252Z")
@Stability(Stable)
public interface IApplicationLoadBalancer
extends software.amazon.jsii.JsiiSerializable, ILoadBalancerV2, IConnectable

An application load balancer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IApplicationLoadBalancer.Jsii$Default	Internal default implementation for IApplicationLoadBalancer.
static final class	IApplicationLoadBalancer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ApplicationListener	addListener(String id, BaseApplicationListenerProps props)	Add a new listener to this load balancer.
default IpAddressType	getIpAddressType()	The IP Address Type for this load balancer.
List<ApplicationListener>	getListeners()	A list of listeners that have been added to the load balancer.
String	getLoadBalancerArn()	The ARN of this load balancer.
IApplicationLoadBalancerMetrics	getMetrics()	All metrics available for this load balancer.
default IVpc	getVpc()	The VPC this load balancer has been created in (if available).

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.ILoadBalancerV2

getLoadBalancerCanonicalHostedZoneId, getLoadBalancerDnsName

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getListeners

@Stability(Stable)
@NotNull
List<ApplicationListener> getListeners()

A list of listeners that have been added to the load balancer.

This list is only valid for owned constructs.

getLoadBalancerArn

@Stability(Stable)
@NotNull
String getLoadBalancerArn()

The ARN of this load balancer.

getMetrics

@Stability(Stable)
@NotNull
IApplicationLoadBalancerMetrics getMetrics()

All metrics available for this load balancer.

getIpAddressType

@Stability(Stable)
@Nullable
default IpAddressType getIpAddressType()

The IP Address Type for this load balancer.

If the @aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault feature flag is set (the default for new projects), and addListener() is called with open: true, the load balancer's security group will automatically include both IPv4 and IPv6 ingress rules when using IpAddressType.DUAL_STACK_WITHOUT_PUBLIC_IPV4.

For existing projects that only have IPv4 rules, you can opt-in to IPv6 ingress rules by enabling the feature flag in your cdk.json file. Note that enabling this feature flag will modify existing security group rules.

Default: IpAddressType.IPV4

getVpc

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

The VPC this load balancer has been created in (if available).

If this interface is the result of an import call to fromApplicationLoadBalancerAttributes, the vpc attribute will be undefined unless specified in the optional properties of that method.

addListener

@Stability(Stable)
@NotNull
ApplicationListener addListener(@NotNull
 String id,
 @NotNull
 BaseApplicationListenerProps props)

Add a new listener to this load balancer.

Parameters:

id - This parameter is required.

props - This parameter is required.