Skip to content
v2.274.0

VirtualGatewayBaseProps Struct ​

Basic configuration properties for a VirtualGateway.

Example ​

ts
declare const mesh: appmesh.Mesh;

const gateway = mesh.addVirtualGateway('gateway', {
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
  virtualGatewayName: 'virtualGateway',
    listeners: [appmesh.VirtualGatewayListener.http({
      port: 443,
      healthCheck: appmesh.HealthCheck.http({
        interval: Duration.seconds(10),
      }),
  })],
});

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.

virtualGatewayNameoptionalstringvirtual_gateway_nameoptionalstrvirtualGatewayNameoptionalStringVirtualGatewayNameoptionalstringVirtualGatewayNameoptional*string#
Name of the VirtualGateway.

Default: A name is automatically determined