aws-cdk-lib.aws_appmesh.GrpcGatewayListenerOptions

interface GrpcGatewayListenerOptions

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.GrpcGatewayListenerOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#GrpcGatewayListenerOptions
Javasoftware.amazon.awscdk.services.appmesh.GrpcGatewayListenerOptions
Pythonaws_cdk.aws_appmesh.GrpcGatewayListenerOptions
TypeScript (source)aws-cdk-lib » aws_appmesh » GrpcGatewayListenerOptions

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

Example

// A Virtual Node with listener TLS from an ACM provided certificate
declare const cert: certificatemanager.Certificate;
declare const mesh: appmesh.Mesh;

const node = new appmesh.VirtualNode(this, 'node', {
  mesh,
  serviceDiscovery: appmesh.ServiceDiscovery.dns('node'),
  listeners: [appmesh.VirtualNodeListener.grpc({
    port: 80,
    tls: {
      mode: appmesh.TlsMode.STRICT,
      certificate: appmesh.TlsCertificate.acm(cert),
    },
  })],
});

// A Virtual Gateway with listener TLS from a customer provided file certificate
const gateway = new appmesh.VirtualGateway(this, 'gateway', {
  mesh,
  listeners: [appmesh.VirtualGatewayListener.grpc({
    port: 8080,
    tls: {
      mode: appmesh.TlsMode.STRICT,
      certificate: appmesh.TlsCertificate.file('path/to/certChain', 'path/to/privateKey'),
    },
  })],
  virtualGatewayName: 'gateway',
});

// A Virtual Gateway with listener TLS from a SDS provided certificate
const gateway2 = new appmesh.VirtualGateway(this, 'gateway2', {
  mesh,
  listeners: [appmesh.VirtualGatewayListener.http2({
    port: 8080,
    tls: {
      mode: appmesh.TlsMode.STRICT,
      certificate: appmesh.TlsCertificate.sds('secrete_certificate'),
    },
  })],
  virtualGatewayName: 'gateway2',
});

Properties

NameTypeDescription
connectionPool?GrpcConnectionPoolConnection pool for http listeners.
healthCheck?HealthCheckThe health check information for the listener.
port?numberPort to listen for connections on.
tls?ListenerTlsOptionsRepresents the configuration for enabling TLS on a listener.

connectionPool?

Type: GrpcConnectionPool (optional, default: None)

Connection pool for http listeners.


healthCheck?

Type: HealthCheck (optional, default: no healthcheck)

The health check information for the listener.


port?

Type: number (optional, default: 8080)

Port to listen for connections on.


tls?

Type: ListenerTlsOptions (optional, default: none)

Represents the configuration for enabling TLS on a listener.