Package software.amazon.awscdk.services.appmesh

Interface IVirtualNode

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, IVirtualNodeRef, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IVirtualNode.Jsii$Default

All Known Implementing Classes:

IVirtualNode.Jsii$Proxy, VirtualNode

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.916Z")
@Stability(Stable)
public interface IVirtualNode
extends software.amazon.jsii.JsiiSerializable, IResource, IVirtualNodeRef

Interface which all VirtualNode based classes must implement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IVirtualNode.Jsii$Default	Internal default implementation for IVirtualNode.
static final class	IVirtualNode.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ResourceEnvironment	getEnv()	The environment this resource belongs to.
IMesh	getMesh()	The Mesh which the VirtualNode belongs to.
software.constructs.Node	getNode()	The tree node.
String	getVirtualNodeArn()	The Amazon Resource Name belonging to the VirtualNode.
String	getVirtualNodeName()	The name of the VirtualNode.
Grant	grantStreamAggregatedResources(IGrantable identity)	Grants the given entity appmesh:StreamAggregatedResources.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.interfaces.appmesh.IVirtualNodeRef

getVirtualNodeRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMesh

@Stability(Stable)
@NotNull
IMesh getMesh()

The Mesh which the VirtualNode belongs to.

getVirtualNodeArn

@Stability(Stable)
@NotNull
String getVirtualNodeArn()

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.

getVirtualNodeName

@Stability(Stable)
@NotNull
String getVirtualNodeName()

The name of the VirtualNode.

grantStreamAggregatedResources

@Stability(Stable)
@NotNull
Grant grantStreamAggregatedResources(@NotNull
 IGrantable identity)

Grants the given entity appmesh:StreamAggregatedResources.

Parameters:

identity - This parameter is required.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware