Package software.amazon.awscdk.services.appmesh

Interface VirtualGatewayBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

VirtualGatewayProps

All Known Implementing Classes:

VirtualGatewayBaseProps.Jsii$Proxy, VirtualGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:34.316Z")
@Stability(Stable)
public interface VirtualGatewayBaseProps
extends software.amazon.jsii.JsiiSerializable

Basic configuration properties for a VirtualGateway.

Example:

 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	VirtualGatewayBaseProps.Builder	A builder for VirtualGatewayBaseProps
static final class	VirtualGatewayBaseProps.Jsii$Proxy	An implementation for VirtualGatewayBaseProps

Method Summary

Modifier and Type	Method	Description
static VirtualGatewayBaseProps.Builder	builder()
default AccessLog	getAccessLog()	Access Logging Configuration for the VirtualGateway.
default BackendDefaults	getBackendDefaults()	Default Configuration Virtual Node uses to communicate with Virtual Service.
default List<VirtualGatewayListener>	getListeners()	Listeners for the VirtualGateway.
default String	getVirtualGatewayName()	Name of the VirtualGateway.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessLog

@Stability(Stable)
@Nullable
default AccessLog getAccessLog()

Access Logging Configuration for the VirtualGateway.

Default: - no access logging

getBackendDefaults

@Stability(Stable)
@Nullable
default BackendDefaults getBackendDefaults()

Default Configuration Virtual Node uses to communicate with Virtual Service.

Default: - No Config

getListeners

@Stability(Stable)
@Nullable
default List<VirtualGatewayListener> getListeners()

Listeners for the VirtualGateway.

Only one is supported.

Default: - Single HTTP listener on port 8080

getVirtualGatewayName

@Stability(Stable)
@Nullable
default String getVirtualGatewayName()

Name of the VirtualGateway.

Default: - A name is automatically determined

builder

@Stability(Stable)
static VirtualGatewayBaseProps.Builder builder()

Returns:

a VirtualGatewayBaseProps.Builder of VirtualGatewayBaseProps