@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-17T17:31:18.481Z")
public interface BaseApplicationListenerProps
Example:
import software.amazon.awscdk.services.apigatewayv2.integrations.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().appendHeader("header2", MappingValue.requestHeader("header1")).removeHeader("header1"))
.build())
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
BaseApplicationListenerProps.Builder
A builder for
BaseApplicationListenerProps |
static class |
BaseApplicationListenerProps.Jsii$Proxy
An implementation for
BaseApplicationListenerProps |
| Modifier and Type | Method and Description |
|---|---|
static BaseApplicationListenerProps.Builder |
builder() |
default java.util.List<java.lang.String> |
getCertificateArns()
Deprecated.
Use the `certificates` property instead
|
default java.util.List<IListenerCertificate> |
getCertificates()
Certificate list of ACM cert ARNs.
|
default ListenerAction |
getDefaultAction()
Default action to take for requests to this listener.
|
default java.util.List<IApplicationTargetGroup> |
getDefaultTargetGroups()
Default target groups to load balance to.
|
default java.lang.Boolean |
getOpen()
Allow anyone to connect to the load balancer on the listener port.
|
default java.lang.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.
|
@Deprecated default java.util.List<java.lang.String> getCertificateArns()
Default: - No certificates.
default java.util.List<IListenerCertificate> getCertificates()
You must provide exactly one certificate if the listener protocol is HTTPS or TLS.
Default: - No certificates.
default ListenerAction getDefaultAction()
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.
default java.util.List<IApplicationTargetGroup> getDefaultTargetGroups()
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.
default java.lang.Boolean getOpen()
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
default java.lang.Number getPort()
Default: - Determined from protocol if known.
default ApplicationProtocol getProtocol()
Default: - Determined from port if known.
default SslPolicy getSslPolicy()
Default: - The current predefined security policy.
static BaseApplicationListenerProps.Builder builder()