Skip to content
v2.275.0

VirtualGatewayProps Struct ​

Properties used when creating a new VirtualGateway.

Example ​

ts
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',
});

Properties ​

accessLogoptionalAccessLogaccess_logoptionalAccessLogaccessLogoptionalAccessLogAccessLogoptionalAccessLogAccessLogoptionalAccessLog#
Access Logging Configuration for the VirtualGateway.

Default: no access logging

backendDefaultsoptionalBackendDefaultsbackend_defaultsoptionalBackendDefaultsbackendDefaultsoptionalBackendDefaultsBackendDefaultsoptionalBackendDefaultsBackendDefaultsoptionalBackendDefaults#
Default Configuration Virtual Node uses to communicate with Virtual Service.

Default: No Config

listenersoptionalVirtualGatewayListener[]listenersoptionaltyping.List[VirtualGatewayListener]listenersoptionalList<VirtualGatewayListener>ListenersoptionalVirtualGatewayListener[]Listenersoptional*[]VirtualGatewayListener#
Listeners for the VirtualGateway.

Default: Single HTTP listener on port 8080

Only one is supported.

meshIMeshmeshIMeshmeshIMeshMeshIMeshMeshIMeshrequired#
The Mesh which the VirtualGateway belongs to.
virtualGatewayNameoptionalstringvirtual_gateway_nameoptionalstrvirtualGatewayNameoptionalStringVirtualGatewayNameoptionalstringVirtualGatewayNameoptional*string#
Name of the VirtualGateway.

Default: A name is automatically determined