class VirtualGatewayListener

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.VirtualGatewayListener
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#VirtualGatewayListener
Java	software.amazon.awscdk.services.appmesh.VirtualGatewayListener
Python	aws_cdk.aws_appmesh.VirtualGatewayListener
TypeScript (source)	aws-cdk-lib » aws_appmesh » VirtualGatewayListener

Represents the properties needed to define listeners for a VirtualGateway.

Example

declare const mesh: appmesh.Mesh;
const certificateAuthorityArn = 'arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012';

const gateway = new appmesh.VirtualGateway(this, 'gateway', {
  mesh: mesh,
  listeners: [appmesh.VirtualGatewayListener.http({
    port: 443,
    healthCheck: appmesh.HealthCheck.http({
      interval: Duration.seconds(10),
    }),
  })],
  backendDefaults: {
    tlsClientPolicy: {
      ports: [8080, 8081],
      validation: {
        trust: appmesh.TlsValidationTrust.acm([
          acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'certificate', certificateAuthorityArn)]),
      },
    },
  },
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
  virtualGatewayName: 'virtualGateway',
});

Initializer

new VirtualGatewayListener()

Methods

Name	Description
bind(scope)	Called when the GatewayListener type is initialized.
static grpc(options?)	Returns a GRPC Listener for a VirtualGateway.
static http(options?)	Returns an HTTP Listener for a VirtualGateway.
static http2(options?)	Returns an HTTP2 Listener for a VirtualGateway.

---

bind(scope)

public bind(scope: Construct): VirtualGatewayListenerConfig

Parameters

• scope Construct

Returns

• VirtualGatewayListenerConfig

Called when the GatewayListener type is initialized.

Can be used to enforce mutual exclusivity

---

static grpc(options?)

public static grpc(options?: GrpcGatewayListenerOptions): VirtualGatewayListener

Parameters

• options GrpcGatewayListenerOptions

Returns

• VirtualGatewayListener

Returns a GRPC Listener for a VirtualGateway.

---

static http(options?)

public static http(options?: HttpGatewayListenerOptions): VirtualGatewayListener

Parameters

• options HttpGatewayListenerOptions

Returns

• VirtualGatewayListener

Returns an HTTP Listener for a VirtualGateway.

---

static http2(options?)

public static http2(options?: Http2GatewayListenerOptions): VirtualGatewayListener

Parameters

• options Http2GatewayListenerOptions

Returns

• VirtualGatewayListener

Returns an HTTP2 Listener for a VirtualGateway.