Package software.amazon.awscdk.services.appmesh

Interface GrpcVirtualNodeListenerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrpcVirtualNodeListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:07.098Z")
@Stability(Stable)
public interface GrpcVirtualNodeListenerOptions
extends software.amazon.jsii.JsiiSerializable

Represent the GRPC Node Listener property.

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

Method Summary

Modifier and Type	Method	Description
static GrpcVirtualNodeListenerOptions.Builder	builder()
default GrpcConnectionPool	getConnectionPool()	Connection pool for http listeners.
default HealthCheck	getHealthCheck()	The health check information for the listener.
default OutlierDetection	getOutlierDetection()	Represents the configuration for enabling outlier detection.
default Number	getPort()	Port to listen for connections on.
default GrpcTimeout	getTimeout()	Timeout for GRPC protocol.
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

getOutlierDetection

@Stability(Stable)
@Nullable
default OutlierDetection getOutlierDetection()

Represents the configuration for enabling outlier detection.

Default: - none

getPort

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

Port to listen for connections on.

Default: - 8080

getTimeout

@Stability(Stable)
@Nullable
default GrpcTimeout getTimeout()

Timeout for GRPC protocol.

Default: - None

getTls

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

Represents the configuration for enabling TLS on a listener.

Default: - none

builder

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

Returns:

a GrpcVirtualNodeListenerOptions.Builder of GrpcVirtualNodeListenerOptions