interface IMesh

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.IMesh
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#IMesh
Java	software.amazon.awscdk.services.appmesh.IMesh
Python	aws_cdk.aws_appmesh.IMesh
TypeScript (source)	aws-cdk-lib » aws_appmesh » IMesh

Implemented by Mesh

Obtainable from Mesh.fromMeshArn(), Mesh.fromMeshName()

Interface which all Mesh based classes MUST implement.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
meshArn	string	The Amazon Resource Name (ARN) of the AppMesh mesh.
meshName	string	The name of the AppMesh mesh.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

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.

---

meshArn

Type: string

The Amazon Resource Name (ARN) of the AppMesh mesh.

---

meshName

Type: string

The name of the AppMesh mesh.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addVirtualGateway(id, props?)	Creates a new VirtualGateway in this Mesh.
addVirtualNode(id, props?)	Creates a new VirtualNode in this Mesh.
addVirtualRouter(id, props?)	Creates a new VirtualRouter in this Mesh.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addVirtualGateway(id, props?)

public addVirtualGateway(id: string, props?: VirtualGatewayBaseProps): VirtualGateway

Parameters

• id string
• props VirtualGatewayBaseProps

Returns

• VirtualGateway

Creates a new VirtualGateway in this Mesh.

Note that the Gateway is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

---

addVirtualNode(id, props?)

public addVirtualNode(id: string, props?: VirtualNodeBaseProps): VirtualNode

Parameters

• id string
• props VirtualNodeBaseProps

Returns

• VirtualNode

Creates a new VirtualNode in this Mesh.

Note that the Node is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

---

addVirtualRouter(id, props?)

public addVirtualRouter(id: string, props?: VirtualRouterBaseProps): VirtualRouter

Parameters

• id string
• props VirtualRouterBaseProps

Returns

• VirtualRouter

Creates a new VirtualRouter in this Mesh.

Note that the Router is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

---

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).