software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseApplicationListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationListenerProps

All Known Implementing Classes:

ApplicationListenerProps.Jsii$Proxy, BaseApplicationListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.063Z")
 @Stability(value=Stable)
public interface BaseApplicationListenerProps
extends software.amazon.jsii.JsiiSerializable

Basic properties for an ApplicationListener.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.alpha.HttpAlbIntegration;
 ApplicationLoadBalancer lb;
 ApplicationListener listener = lb.addListener("listener", BaseApplicationListenerProps.builder().port(80).build());
 listener.addTargets("target", AddApplicationTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(HttpAlbIntegration.Builder.create("DefaultIntegration", listener)
                 .parameterMapping(new ParameterMapping().custom("myKey", "myValue"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BaseApplicationListenerProps.Builder	builder()
default List<IListenerCertificate>	getCertificates() Certificate list of ACM cert ARNs.
default ListenerAction	getDefaultAction() Default action to take for requests to this listener.
default List<IApplicationTargetGroup>	getDefaultTargetGroups() Default target groups to load balance to.
default Boolean	getOpen() Allow anyone to connect to the load balancer on the listener port.
default Number	getPort() The port on which the listener listens for requests.
default ApplicationProtocol	getProtocol() The protocol to use.
default SslPolicy	getSslPolicy() The security policy that defines which ciphers and protocols are supported.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificates

@Stability(value=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(value=Stable)
 @Nullable
default ListenerAction getDefaultAction()

Default action to take for requests to this listener.

This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses.

See the ListenerAction class for all options.

Cannot be specified together with defaultTargetGroups.

Default: - None.

getDefaultTargetGroups

@Stability(value=Stable)
 @Nullable
default List<IApplicationTargetGroup> 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.

getOpen

@Stability(value=Stable)
 @Nullable
default Boolean getOpen()

Allow anyone to connect to the load balancer on the listener port.

If this is specified, the load balancer will be opened up to anyone who can reach it. For internal load balancers this is anyone in the same VPC. For public load balancers, this is anyone on the internet.

If you want to be more selective about who can access this load balancer, set this to false and use the listener's connections object to selectively grant access to the load balancer on the listener port.

Default: true

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

The port on which the listener listens for requests.

Default: - Determined from protocol if known.

getProtocol

@Stability(value=Stable)
 @Nullable
default ApplicationProtocol getProtocol()

The protocol to use.

Default: - Determined from port if known.

getSslPolicy

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

The security policy that defines which ciphers and protocols are supported.

Default: - The current predefined security policy.

builder

@Stability(value=Stable)
static BaseApplicationListenerProps.Builder builder()

Returns:

a BaseApplicationListenerProps.Builder of BaseApplicationListenerProps