interface IVirtualRouter

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

Implemented by VirtualRouter

Obtainable from VirtualRouter.fromVirtualRouterArn(), VirtualRouter.fromVirtualRouterAttributes()

Interface which all VirtualRouter based classes MUST implement.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
mesh	IMesh	The Mesh which the VirtualRouter belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
virtualRouterArn	string	The Amazon Resource Name (ARN) for the VirtualRouter.
virtualRouterName	string	The name of the VirtualRouter.

---

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.

---

mesh

Type: IMesh

The Mesh which the VirtualRouter belongs to.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

virtualRouterArn

Type: string

The Amazon Resource Name (ARN) for the VirtualRouter.

---

virtualRouterName

Type: string

The name of the VirtualRouter.

Methods

Name	Description
addRoute(id, props)	Add a single route to the router.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addRoute(id, props)

public addRoute(id: string, props: RouteBaseProps): Route

Parameters

• id string
• props RouteBaseProps

Returns

• Route

Add a single route to the router.

---

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