Package 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.74.0 (build 6d08790)", date="2023-05-31T18:44:15.784Z") @Stability(Stable) public interface BaseApplicationListenerProps extends software.amazon.jsii.JsiiSerializable
Basic properties for an ApplicationListener.

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();

  • Method Details

    • getCertificateArns

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getCertificateArns()
      Deprecated.
      Use the `certificates` property instead
      (deprecated) The certificates to use on this listener.

      Default: - No certificates.

    • 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 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(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(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(Stable) @Nullable default Number getPort()
      The port on which the listener listens for requests.

      Default: - Determined from protocol if known.

    • getProtocol

      @Stability(Stable) @Nullable default ApplicationProtocol getProtocol()
      The protocol to use.

      Default: - Determined from port if known.

    • getSslPolicy

      @Stability(Stable) @Nullable default SslPolicy getSslPolicy()
      The security policy that defines which ciphers and protocols are supported.

      Default: - The current predefined security policy.

    • builder

      @Stability(Stable) static BaseApplicationListenerProps.Builder builder()
      Returns:
      a BaseApplicationListenerProps.Builder of BaseApplicationListenerProps