Skip to content
v2.277.0

GrpcVirtualNodeListenerOptions Struct ​

Represent the GRPC Node Listener property.

Example ​

ts
// 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',
});
python
# A Virtual Node with listener TLS from an ACM provided certificate
# cert: certificatemanager.Certificate
# mesh: appmesh.Mesh


node = appmesh.VirtualNode(self, "node",
    mesh=mesh,
    service_discovery=appmesh.ServiceDiscovery.dns("node"),
    listeners=[appmesh.VirtualNodeListener.grpc(
        port=80,
        tls=appmesh.ListenerTlsOptions(
            mode=appmesh.TlsMode.STRICT,
            certificate=appmesh.TlsCertificate.acm(cert)
        )
    )]
)

# A Virtual Gateway with listener TLS from a customer provided file certificate
gateway = appmesh.VirtualGateway(self, "gateway",
    mesh=mesh,
    listeners=[appmesh.VirtualGatewayListener.grpc(
        port=8080,
        tls=appmesh.ListenerTlsOptions(
            mode=appmesh.TlsMode.STRICT,
            certificate=appmesh.TlsCertificate.file("path/to/certChain", "path/to/privateKey")
        )
    )],
    virtual_gateway_name="gateway"
)

# A Virtual Gateway with listener TLS from a SDS provided certificate
gateway2 = appmesh.VirtualGateway(self, "gateway2",
    mesh=mesh,
    listeners=[appmesh.VirtualGatewayListener.http2(
        port=8080,
        tls=appmesh.ListenerTlsOptions(
            mode=appmesh.TlsMode.STRICT,
            certificate=appmesh.TlsCertificate.sds("secrete_certificate")
        )
    )],
    virtual_gateway_name="gateway2"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// A Virtual Node with listener TLS from an ACM provided certificate
Certificate cert;
Mesh mesh;


var node = new VirtualNode(this, "node", new VirtualNodeProps {
    Mesh = mesh,
    ServiceDiscovery = ServiceDiscovery.Dns("node"),
    Listeners = new [] { VirtualNodeListener.Grpc(new GrpcVirtualNodeListenerOptions {
        Port = 80,
        Tls = new ListenerTlsOptions {
            Mode = TlsMode.STRICT,
            Certificate = TlsCertificate.Acm(cert)
        }
    }) }
});

// A Virtual Gateway with listener TLS from a customer provided file certificate
var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
    Mesh = mesh,
    Listeners = new [] { VirtualGatewayListener.Grpc(new GrpcGatewayListenerOptions {
        Port = 8080,
        Tls = new ListenerTlsOptions {
            Mode = TlsMode.STRICT,
            Certificate = TlsCertificate.File("path/to/certChain", "path/to/privateKey")
        }
    }) },
    VirtualGatewayName = "gateway"
});

// A Virtual Gateway with listener TLS from a SDS provided certificate
var gateway2 = new VirtualGateway(this, "gateway2", new VirtualGatewayProps {
    Mesh = mesh,
    Listeners = new [] { VirtualGatewayListener.Http2(new Http2GatewayListenerOptions {
        Port = 8080,
        Tls = new ListenerTlsOptions {
            Mode = TlsMode.STRICT,
            Certificate = TlsCertificate.Sds("secrete_certificate")
        }
    }) },
    VirtualGatewayName = "gateway2"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// A Virtual Node with listener TLS from an ACM provided certificate
var cert Certificate
var mesh Mesh


node := appmesh.NewVirtualNode(this, jsii.String("node"), &VirtualNodeProps{
	Mesh: Mesh,
	ServiceDiscovery: appmesh.ServiceDiscovery_Dns(jsii.String("node")),
	Listeners: []VirtualNodeListener{
		appmesh.VirtualNodeListener_Grpc(&GrpcVirtualNodeListenerOptions{
			Port: jsii.Number(80),
			Tls: &ListenerTlsOptions{
				Mode: appmesh.TlsMode_STRICT,
				Certificate: appmesh.TlsCertificate_Acm(cert),
			},
		}),
	},
})

// A Virtual Gateway with listener TLS from a customer provided file certificate
gateway := appmesh.NewVirtualGateway(this, jsii.String("gateway"), &VirtualGatewayProps{
	Mesh: Mesh,
	Listeners: []VirtualGatewayListener{
		appmesh.VirtualGatewayListener_Grpc(&GrpcGatewayListenerOptions{
			Port: jsii.Number(8080),
			Tls: &ListenerTlsOptions{
				Mode: appmesh.TlsMode_STRICT,
				Certificate: appmesh.TlsCertificate_File(jsii.String("path/to/certChain"), jsii.String("path/to/privateKey")),
			},
		}),
	},
	VirtualGatewayName: jsii.String("gateway"),
})

// A Virtual Gateway with listener TLS from a SDS provided certificate
gateway2 := appmesh.NewVirtualGateway(this, jsii.String("gateway2"), &VirtualGatewayProps{
	Mesh: Mesh,
	Listeners: []VirtualGatewayListener{
		appmesh.VirtualGatewayListener_Http2(&Http2GatewayListenerOptions{
			Port: jsii.Number(8080),
			Tls: &ListenerTlsOptions{
				Mode: appmesh.TlsMode_STRICT,
				Certificate: appmesh.TlsCertificate_Sds(jsii.String("secrete_certificate")),
			},
		}),
	},
	VirtualGatewayName: jsii.String("gateway2"),
})

Properties ​

connectionPooloptionalGrpcConnectionPoolconnection_pooloptionalGrpcConnectionPoolconnectionPooloptionalGrpcConnectionPoolConnectionPooloptionalGrpcConnectionPoolConnectionPooloptionalGrpcConnectionPool = None #
Connection pool for http listeners.
healthCheckoptionalHealthCheckhealth_checkoptionalHealthCheckhealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheck #
The health check information for the listener.

Default: no healthcheck

outlierDetectionoptionalOutlierDetectionoutlier_detectionoptionalOutlierDetectionoutlierDetectionoptionalOutlierDetectionOutlierDetectionoptionalOutlierDetectionOutlierDetectionoptionalOutlierDetection = none #
Represents the configuration for enabling outlier detection.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64 = 8080 #
Port to listen for connections on.
timeoutoptionalGrpcTimeouttimeoutoptionalGrpcTimeouttimeoutoptionalGrpcTimeoutTimeoutoptionalGrpcTimeoutTimeoutoptionalGrpcTimeout = None #
Timeout for GRPC protocol.
tlsoptionalListenerTlsOptionstlsoptionalListenerTlsOptionstlsoptionalListenerTlsOptionsTlsoptionalListenerTlsOptionsTlsoptionalListenerTlsOptions = none #
Represents the configuration for enabling TLS on a listener.