interface IVirtualNode

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

Implemented by VirtualNode

Obtainable from VirtualNode.fromVirtualNodeArn(), VirtualNode.fromVirtualNodeAttributes()

Interface which all VirtualNode based classes must implement.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
mesh	IMesh	The Mesh which the VirtualNode belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
virtualNodeArn	string	The Amazon Resource Name belonging to the VirtualNode.
virtualNodeName	string	The name of the VirtualNode.

---

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 VirtualNode belongs to.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

virtualNodeArn

Type: string

The Amazon Resource Name belonging to the VirtualNode.

Set this value as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec.

---

virtualNodeName

Type: string

The name of the VirtualNode.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantStreamAggregatedResources(identity)	Grants the given entity appmesh:StreamAggregatedResources.

---

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.