interface IVirtualGateway

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.IVirtualGateway
Java	software.amazon.awscdk.services.appmesh.IVirtualGateway
Python	aws_cdk.aws_appmesh.IVirtualGateway
TypeScript (source)	@aws-cdk/aws-appmesh » IVirtualGateway

Implemented by VirtualGateway

Obtainable from VirtualGateway.fromVirtualGatewayArn(), VirtualGateway.fromVirtualGatewayAttributes()

Interface which all Virtual Gateway based classes must implement.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
mesh	IMesh	The Mesh which the VirtualGateway belongs to.
node	ConstructNode	The construct tree node for this construct.
stack	Stack	The stack in which this resource is defined.
virtualGatewayArn	string	The Amazon Resource Name (ARN) for the VirtualGateway.
virtualGatewayName	string	Name of the VirtualGateway.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

mesh

Type: IMesh

The Mesh which the VirtualGateway belongs to.

---

node

Type: ConstructNode

The construct tree node for this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

virtualGatewayArn

Type: string

The Amazon Resource Name (ARN) for the VirtualGateway.

---

virtualGatewayName

Type: string

Name of the VirtualGateway.

Methods

Name	Description
addGatewayRoute(id, route)	Utility method to add a new GatewayRoute to the VirtualGateway.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantStreamAggregatedResources(identity)	Grants the given entity appmesh:StreamAggregatedResources.

---

addGatewayRoute(id, route)

public addGatewayRoute(id: string, route: GatewayRouteBaseProps): GatewayRoute

Parameters

• id string
• route GatewayRouteBaseProps

Returns

• GatewayRoute

Utility method to add a new GatewayRoute to the VirtualGateway.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantStreamAggregatedResources(identity)

public grantStreamAggregatedResources(identity: IGrantable): Grant

Parameters

• identity IGrantable

Returns

• Grant

Grants the given entity appmesh:StreamAggregatedResources.