software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseNetworkListenerProps

All Known Subinterfaces:

NetworkListenerProps

All Known Implementing Classes:

BaseNetworkListenerProps.Jsii$Proxy, NetworkListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:07.822Z")
public interface BaseNetworkListenerProps

Basic properties for a Network Listener.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpNlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "lb").vpc(vpc).build();
 NetworkListener listener = lb.addListener("listener", BaseNetworkListenerProps.builder().port(80).build());
 listener.addTargets("target", AddNetworkTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(new HttpNlbIntegration("DefaultIntegration", listener))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 java.util.List<IListenerCertificate>	getCertificates() Certificate list of ACM cert ARNs.
default NetworkListenerAction	getDefaultAction() Default action to take for requests to this listener.
default java.util.List<INetworkTargetGroup>	getDefaultTargetGroups() Default target groups to load balance to.
java.lang.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.

Method Detail

getPort

java.lang.Number getPort()

The port on which the listener listens for requests.

getAlpnPolicy

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

default java.util.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

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

default java.util.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

default Protocol getProtocol()

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

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

getSslPolicy

default SslPolicy getSslPolicy()

SSL Policy.

Default: - Current predefined security policy.

builder

static BaseNetworkListenerProps.Builder builder()

Returns:

a BaseNetworkListenerProps.Builder of BaseNetworkListenerProps