Interface IApplicationLoadBalancer

An application load balancer.

Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IApplicationLoadBalancer : ILoadBalancerV2, IResource, IConnectable, IApplicationLoadBalancerRef, ILoadBalancerRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IApplicationLoadBalancer Inherits ILoadBalancerV2, IResource, IConnectable, IApplicationLoadBalancerRef, ILoadBalancerRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

IpAddressType

The IP Address Type for this load balancer.
Listeners

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

The ARN of this load balancer.
Metrics

All metrics available for this load balancer.
Vpc

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

Methods

AddListener(string, IBaseApplicationListenerProps)

Add a new listener to this load balancer.

Properties

IpAddressType

The IP Address Type for this load balancer.

IpAddressType? IpAddressType { get; }
Property Value

IpAddressType?

Remarks

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

Listeners

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

ApplicationListener[] Listeners { get; }
Property Value

ApplicationListener[]

Remarks

This list is only valid for owned constructs.

LoadBalancerArn

The ARN of this load balancer.

string LoadBalancerArn { get; }
Property Value

string

Metrics

All metrics available for this load balancer.

IApplicationLoadBalancerMetrics Metrics { get; }
Property Value

IApplicationLoadBalancerMetrics

Vpc

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

IVpc? Vpc { get; }
Property Value

IVpc

Remarks

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.

Methods

AddListener(string, IBaseApplicationListenerProps)

Add a new listener to this load balancer.

ApplicationListener AddListener(string id, IBaseApplicationListenerProps props)
Parameters
id string
props IBaseApplicationListenerProps
Returns

ApplicationListener