Package software.amazon.awscdk.services.appmesh

Interface IVirtualGateway

All Superinterfaces:

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

All Known Subinterfaces:

IVirtualGateway.Jsii$Default

All Known Implementing Classes:

IVirtualGateway.Jsii$Proxy, VirtualGateway

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.915Z")
@Stability(Stable)
public interface IVirtualGateway
extends software.amazon.jsii.JsiiSerializable, IResource, IVirtualGatewayRef

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.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
IMesh	getMesh()	The Mesh which the VirtualGateway belongs to.
software.constructs.Node	getNode()	The tree node.
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.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.interfaces.appmesh.IVirtualGatewayRef

getVirtualGatewayRef

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.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware