Skip to content
v2.277.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),
      }),
  })],
});
python
# mesh: appmesh.Mesh


gateway = mesh.add_virtual_gateway("gateway",
    access_log=appmesh.AccessLog.from_file_path("/dev/stdout"),
    virtual_gateway_name="virtualGateway",
    listeners=[appmesh.VirtualGatewayListener.http(
        port=443,
        health_check=appmesh.HealthCheck.http(
            interval=Duration.seconds(10)
        )
    )]
)
java
Mesh mesh;


VirtualGateway gateway = mesh.addVirtualGateway("gateway", VirtualGatewayBaseProps.builder()
        .accessLog(AccessLog.fromFilePath("/dev/stdout"))
        .virtualGatewayName("virtualGateway")
        .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder()
                .port(443)
                .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                        .interval(Duration.seconds(10))
                        .build()))
                .build())))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Mesh mesh;


var gateway = mesh.AddVirtualGateway("gateway", new VirtualGatewayBaseProps {
    AccessLog = AccessLog.FromFilePath("/dev/stdout"),
    VirtualGatewayName = "virtualGateway",
    Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
        Port = 443,
        HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
            Interval = Duration.Seconds(10)
        })
    }) }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var mesh Mesh


gateway := mesh.addVirtualGateway(jsii.String("gateway"), &VirtualGatewayBaseProps{
	AccessLog: appmesh.AccessLog_FromFilePath(jsii.String("/dev/stdout")),
	VirtualGatewayName: jsii.String("virtualGateway"),
	Listeners: []VirtualGatewayListener{
		appmesh.VirtualGatewayListener_Http(&HttpGatewayListenerOptions{
			Port: jsii.Number(443),
			HealthCheck: appmesh.HealthCheck_Http(&HttpHealthCheckOptions{
				Interval: awscdk.Duration_Seconds(jsii.Number(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