class VirtualRouter (construct)

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

Implements IConstruct, IConstruct, IDependable, IResource, IVirtualRouter

Example

declare const mesh: appmesh.Mesh;
const router = mesh.addVirtualRouter('router', {
  listeners: [appmesh.VirtualRouterListener.http(8080)],
});

Initializer

new VirtualRouter(scope: Construct, id: string, props: VirtualRouterProps)

Parameters

• scope Construct
• id string
• props VirtualRouterProps

Construct Props

Name	Type	Description
mesh	IMesh	The Mesh which the VirtualRouter belongs to.
listeners?	VirtualRouterListener[]	Listener specification for the VirtualRouter.
virtualRouterName?	string	The name of the VirtualRouter.

---

mesh

Type: IMesh

The Mesh which the VirtualRouter belongs to.

---

listeners?

Type: VirtualRouterListener[] (optional, default: A listener on HTTP port 8080)

Listener specification for the VirtualRouter.

---

virtualRouterName?

Type: string (optional, default: A name is automatically determined)

The name of the VirtualRouter.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
mesh	IMesh	The Mesh which the VirtualRouter belongs to.
node	ConstructNode	The construct tree node associated with this construct.
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 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 VirtualRouter belongs to.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

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.
toString()	Returns a string representation of this construct.
static fromVirtualRouterArn(scope, id, virtualRouterArn)	Import an existing VirtualRouter given an ARN.
static fromVirtualRouterAttributes(scope, id, attrs)	Import an existing VirtualRouter given attributes.

---

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromVirtualRouterArn(scope, id, virtualRouterArn)

public static fromVirtualRouterArn(scope: Construct, id: string, virtualRouterArn: string): IVirtualRouter

Parameters

• scope Construct
• id string
• virtualRouterArn string

Returns

• IVirtualRouter

Import an existing VirtualRouter given an ARN.

---

static fromVirtualRouterAttributes(scope, id, attrs)

public static fromVirtualRouterAttributes(scope: Construct, id: string, attrs: VirtualRouterAttributes): IVirtualRouter

Parameters

• scope Construct
• id string
• attrs VirtualRouterAttributes

Returns

• IVirtualRouter

Import an existing VirtualRouter given attributes.