software.amazon.awscdk.services.appmesh

Interface HttpGatewayListenerOptions

All Known Implementing Classes:

HttpGatewayListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.606Z")
public interface HttpGatewayListenerOptions

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 and Description
static class	HttpGatewayListenerOptions.Builder A builder for HttpGatewayListenerOptions
static class	HttpGatewayListenerOptions.Jsii$Proxy An implementation for HttpGatewayListenerOptions

Method Summary

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

Method Detail

getConnectionPool

default HttpConnectionPool getConnectionPool()

Connection pool for http listeners.

Default: - None

getHealthCheck

default HealthCheck getHealthCheck()

The health check information for the listener.

Default: - no healthcheck

getPort

default java.lang.Number getPort()

Port to listen for connections on.

Default: - 8080

getTls

default ListenerTlsOptions getTls()

Represents the configuration for enabling TLS on a listener.

Default: - none

builder

static HttpGatewayListenerOptions.Builder builder()

Returns:

a HttpGatewayListenerOptions.Builder of HttpGatewayListenerOptions