Package software.amazon.awscdk.services.ecs.patterns

Interface ApplicationListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplicationListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:50:57.132Z")
@Stability(Stable)
public interface ApplicationListenerProps
extends software.amazon.jsii.JsiiSerializable

Properties to define an application listener.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Certificate certificate;
 ApplicationListenerProps applicationListenerProps = ApplicationListenerProps.builder()
         .name("name")
         // the properties below are optional
         .certificate(certificate)
         .port(123)
         .protocol(ApplicationProtocol.HTTP)
         .sslPolicy(SslPolicy.RECOMMENDED_TLS)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApplicationListenerProps.Builder	builder()
default ICertificate	getCertificate()	Certificate Manager certificate to associate with the load balancer.
String	getName()	Name of the listener.
default Number	getPort()	The port on which the listener listens for requests.
default ApplicationProtocol	getProtocol()	The protocol for connections from clients to the load balancer.
default SslPolicy	getSslPolicy()	The security policy that defines which ciphers and protocols are supported by the ALB Listener.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

Name of the listener.

getCertificate

@Stability(Stable)
@Nullable
default ICertificate getCertificate()

Certificate Manager certificate to associate with the load balancer.

Setting this option will set the load balancer protocol to HTTPS.

Default: - No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name.

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 for connections from clients to the load balancer.

The load balancer port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.

Default: ApplicationProtocol.HTTP. If a certificate is specified, the protocol will be set by default to ApplicationProtocol.HTTPS.

getSslPolicy

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

The security policy that defines which ciphers and protocols are supported by the ALB Listener.

Default: - The recommended elastic load balancing security policy

builder

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

Returns:

a ApplicationListenerProps.Builder of ApplicationListenerProps