Package software.amazon.awscdk.services.appmesh

Interface IVirtualGateway

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IVirtualGateway.Jsii$Default

All Known Implementing Classes:

IVirtualGateway.Jsii$Proxy, VirtualGateway

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.706Z")
@Stability(Stable)
public interface IVirtualGateway
extends software.amazon.jsii.JsiiSerializable, IResource

Interface which all Virtual Gateway based classes must implement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IVirtualGateway.Jsii$Default	Internal default implementation for IVirtualGateway.
static final class	IVirtualGateway.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
GatewayRoute	addGatewayRoute(String id, GatewayRouteBaseProps route)	Utility method to add a new GatewayRoute to the VirtualGateway.
IMesh	getMesh()	The Mesh which the VirtualGateway belongs to.
String	getVirtualGatewayArn()	The Amazon Resource Name (ARN) for the VirtualGateway.
String	getVirtualGatewayName()	Name of the VirtualGateway.
Grant	grantStreamAggregatedResources(IGrantable identity)	Grants the given entity appmesh:StreamAggregatedResources.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMesh

@Stability(Stable)
@NotNull
IMesh getMesh()

The Mesh which the VirtualGateway belongs to.

getVirtualGatewayArn

@Stability(Stable)
@NotNull
String getVirtualGatewayArn()

The Amazon Resource Name (ARN) for the VirtualGateway.

getVirtualGatewayName

@Stability(Stable)
@NotNull
String getVirtualGatewayName()

Name of the VirtualGateway.

addGatewayRoute

@Stability(Stable)
@NotNull
GatewayRoute addGatewayRoute(@NotNull
 String id,
 @NotNull
 GatewayRouteBaseProps route)

Utility method to add a new GatewayRoute to the VirtualGateway.

Parameters:

id - This parameter is required.

route - This parameter is required.

grantStreamAggregatedResources

@Stability(Stable)
@NotNull
Grant grantStreamAggregatedResources(@NotNull
 IGrantable identity)

Grants the given entity appmesh:StreamAggregatedResources.

Parameters:

identity - This parameter is required.