class VirtualService (construct) 🔹

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

Implements IConstruct, IConstruct, IResource, IVirtualService

VirtualService represents a service inside an AppMesh.

It routes traffic either to a Virtual Node or to a Virtual Router.

Initializer

new VirtualService(scope: Construct, id: string, props: VirtualServiceProps)

Parameters

• scope Construct
• id string
• props VirtualServiceProps

Construct Props

Name	Type	Description
mesh🔹	IMesh	The AppMesh mesh name for which the VirtualService belongs to.
virtualNode?🔹	IVirtualNode	The VirtualNode attached to the virtual service.
virtualRouter?🔹	IVirtualRouter	The VirtualRouter which the VirtualService uses as provider.
virtualServiceName?🔹	string	The name of the VirtualService.

---

mesh🔹

Type: IMesh

The AppMesh mesh name for which the VirtualService belongs to.

---

virtualNode?🔹

Type: IVirtualNode (optional, default: At most one of virtualRouter and virtualNode is allowed.)

The VirtualNode attached to the virtual service.

---

virtualRouter?🔹

Type: IVirtualRouter (optional, default: At most one of virtualRouter and virtualNode is allowed.)

The VirtualRouter which the VirtualService uses as provider.

---

virtualServiceName?🔹

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

The name of the VirtualService.

It is recommended this follows the fully-qualified domain name format, such as "my-service.default.svc.cluster.local".

Properties

Name	Type	Description
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.
virtualServiceArn🔹	string	The Amazon Resource Name (ARN) for the virtual service.
virtualServiceName🔹	string	The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

virtualServiceArn🔹

Type: string

The Amazon Resource Name (ARN) for the virtual service.

---

virtualServiceName🔹

Type: string

The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

Methods

Name	Description
toString()🔹	Returns a string representation of this construct.
static fromVirtualServiceArn(scope, id, virtualServiceArn)🔹	Import an existing VirtualService given an ARN.
static fromVirtualServiceName(scope, id, meshName, virtualServiceName)🔹	Import an existing VirtualService given mesh and service names.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromVirtualServiceArn(scope, id, virtualServiceArn)🔹

public static fromVirtualServiceArn(scope: Construct, id: string, virtualServiceArn: string): IVirtualService

Parameters

• scope Construct
• id string
• virtualServiceArn string

Returns

• IVirtualService

Import an existing VirtualService given an ARN.

---

static fromVirtualServiceName(scope, id, meshName, virtualServiceName)🔹

public static fromVirtualServiceName(scope: Construct, id: string, meshName: string, virtualServiceName: string): IVirtualService

Parameters

• scope Construct
• id string
• meshName string
• virtualServiceName string

Returns

• IVirtualService

Import an existing VirtualService given mesh and service names.