Package software.amazon.awscdk.services.appmesh

Interface HttpGatewayListenerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpGatewayListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:03.340Z")
@Stability(Stable)
public interface HttpGatewayListenerOptions
extends software.amazon.jsii.JsiiSerializable

Represents the properties needed to define HTTP Listeners for a VirtualGateway.

Example:

 Mesh mesh;
 String certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";
 VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway")
         .mesh(mesh)
         .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder()
                 .port(443)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .interval(Duration.seconds(10))
                         .build()))
                 .build())))
         .backendDefaults(BackendDefaults.builder()
                 .tlsClientPolicy(TlsClientPolicy.builder()
                         .ports(List.of(8080, 8081))
                         .validation(TlsValidation.builder()
                                 .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn))))
                                 .build())
                         .build())
                 .build())
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .virtualGatewayName("virtualGateway")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpGatewayListenerOptions.Builder	builder()
default HttpConnectionPool	getConnectionPool()	Connection pool for http listeners.
default HealthCheck	getHealthCheck()	The health check information for the listener.
default Number	getPort()	Port to listen for connections on.
default ListenerTlsOptions	getTls()	Represents the configuration for enabling TLS on a listener.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionPool

@Stability(Stable)
@Nullable
default HttpConnectionPool getConnectionPool()

Connection pool for http listeners.

Default: - None

getHealthCheck

@Stability(Stable)
@Nullable
default HealthCheck getHealthCheck()

The health check information for the listener.

Default: - no healthcheck

getPort

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

Port to listen for connections on.

Default: - 8080

getTls

@Stability(Stable)
@Nullable
default ListenerTlsOptions getTls()

Represents the configuration for enabling TLS on a listener.

Default: - none

builder

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

Returns:

a HttpGatewayListenerOptions.Builder of HttpGatewayListenerOptions