Package software.amazon.awscdk.services.appmesh

Interface GrpcGatewayListenerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrpcGatewayListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.059Z")
@Stability(Stable)
public interface GrpcGatewayListenerOptions
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // A Virtual Node with listener TLS from an ACM provided certificate
 Certificate cert;
 Mesh mesh;
 VirtualNode node = VirtualNode.Builder.create(this, "node")
         .mesh(mesh)
         .serviceDiscovery(ServiceDiscovery.dns("node"))
         .listeners(List.of(VirtualNodeListener.grpc(GrpcVirtualNodeListenerOptions.builder()
                 .port(80)
                 .tls(ListenerTlsOptions.builder()
                         .mode(TlsMode.STRICT)
                         .certificate(TlsCertificate.acm(cert))
                         .build())
                 .build())))
         .build();
 // A Virtual Gateway with listener TLS from a customer provided file certificate
 VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway")
         .mesh(mesh)
         .listeners(List.of(VirtualGatewayListener.grpc(GrpcGatewayListenerOptions.builder()
                 .port(8080)
                 .tls(ListenerTlsOptions.builder()
                         .mode(TlsMode.STRICT)
                         .certificate(TlsCertificate.file("path/to/certChain", "path/to/privateKey"))
                         .build())
                 .build())))
         .virtualGatewayName("gateway")
         .build();
 // A Virtual Gateway with listener TLS from a SDS provided certificate
 VirtualGateway gateway2 = VirtualGateway.Builder.create(this, "gateway2")
         .mesh(mesh)
         .listeners(List.of(VirtualGatewayListener.http2(Http2GatewayListenerOptions.builder()
                 .port(8080)
                 .tls(ListenerTlsOptions.builder()
                         .mode(TlsMode.STRICT)
                         .certificate(TlsCertificate.sds("secrete_certificate"))
                         .build())
                 .build())))
         .virtualGatewayName("gateway2")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GrpcGatewayListenerOptions.Builder	builder()
default GrpcConnectionPool	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 GrpcConnectionPool 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 GrpcGatewayListenerOptions.Builder builder()

Returns:

a GrpcGatewayListenerOptions.Builder of GrpcGatewayListenerOptions