Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseNetworkListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

NetworkListenerProps

All Known Implementing Classes:

BaseNetworkListenerProps.Jsii$Proxy, NetworkListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:12.726Z")
@Stability(Stable)
public interface BaseNetworkListenerProps
extends software.amazon.jsii.JsiiSerializable

Basic properties for a Network Listener.

Example:

 Vpc vpc;
 AutoScalingGroup asg;
 ISecurityGroup sg1;
 ISecurityGroup sg2;
 // Create the load balancer in a VPC. 'internetFacing' is 'false'
 // by default, which creates an internal load balancer.
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .securityGroups(List.of(sg1))
         .build();
 lb.addSecurityGroup(sg2);
 // Add a listener on a particular port.
 NetworkListener listener = lb.addListener("Listener", BaseNetworkListenerProps.builder()
         .port(443)
         .build());
 // Add targets on a particular port.
 listener.addTargets("AppFleet", AddNetworkTargetsProps.builder()
         .port(443)
         .targets(List.of(asg))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BaseNetworkListenerProps.Builder	A builder for BaseNetworkListenerProps
static final class	BaseNetworkListenerProps.Jsii$Proxy	An implementation for BaseNetworkListenerProps

Method Summary

Modifier and Type	Method	Description
static BaseNetworkListenerProps.Builder	builder()
default AlpnPolicy	getAlpnPolicy()	Application-Layer Protocol Negotiation (ALPN) is a TLS extension that is sent on the initial TLS handshake hello messages.
default List<IListenerCertificate>	getCertificates()	Certificate list of ACM cert ARNs.
default NetworkListenerAction	getDefaultAction()	Default action to take for requests to this listener.
default List<INetworkTargetGroup>	getDefaultTargetGroups()	Default target groups to load balance to.
Number	getPort()	The port on which the listener listens for requests.
default Protocol	getProtocol()	Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP.
default SslPolicy	getSslPolicy()	SSL Policy.
default Duration	getTcpIdleTimeout()	The load balancer TCP idle timeout.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port on which the listener listens for requests.

getAlpnPolicy

@Stability(Stable)
@Nullable
default AlpnPolicy getAlpnPolicy()

Application-Layer Protocol Negotiation (ALPN) is a TLS extension that is sent on the initial TLS handshake hello messages.

ALPN enables the application layer to negotiate which protocols should be used over a secure connection, such as HTTP/1 and HTTP/2.

Can only be specified together with Protocol TLS.

Default: - None

getCertificates

@Stability(Stable)
@Nullable
default List<IListenerCertificate> getCertificates()

Certificate list of ACM cert ARNs.

You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

Default: - No certificates.

getDefaultAction

@Stability(Stable)
@Nullable
default NetworkListenerAction getDefaultAction()

Default action to take for requests to this listener.

This allows full control of the default Action of the load balancer, including weighted forwarding. See the NetworkListenerAction class for all options.

Cannot be specified together with defaultTargetGroups.

Default: - None.

getDefaultTargetGroups

@Stability(Stable)
@Nullable
default List<INetworkTargetGroup> getDefaultTargetGroups()

Default target groups to load balance to.

All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either defaultAction or addAction().

Cannot be specified together with defaultAction.

Default: - None.

getProtocol

@Stability(Stable)
@Nullable
default Protocol getProtocol()

Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP.

Default: - TLS if certificates are provided. TCP otherwise.

getSslPolicy

@Stability(Stable)
@Nullable
default SslPolicy getSslPolicy()

SSL Policy.

Default: - Current predefined security policy.

getTcpIdleTimeout

@Stability(Stable)
@Nullable
default Duration getTcpIdleTimeout()

The load balancer TCP idle timeout.

Default: Duration.seconds(350)

builder

@Stability(Stable)
static BaseNetworkListenerProps.Builder builder()

Returns:

a BaseNetworkListenerProps.Builder of BaseNetworkListenerProps