software.amazon.awscdk.services.appmesh

Class VirtualNode

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appmesh.VirtualNode

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVirtualNode

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.690Z")
public class VirtualNode
extends Resource
implements IVirtualNode

VirtualNode represents a newly defined AppMesh VirtualNode.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.

Example:

 Mesh mesh;
 // Cloud Map service discovery is currently required for host ejection by outlier detection
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .outlierDetection(OutlierDetection.builder()
                         .baseEjectionDuration(Duration.seconds(10))
                         .interval(Duration.seconds(30))
                         .maxEjectionPercent(50)
                         .maxServerErrors(5)
                         .build())
                 .build())))
         .build());
 

See Also:

https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualNode.Builder A fluent builder for VirtualNode.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appmesh.IVirtualNode

IVirtualNode.Jsii$Default, IVirtualNode.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualNode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VirtualNode(software.amazon.jsii.JsiiObjectRef objRef)
	VirtualNode(software.constructs.Construct scope, java.lang.String id, VirtualNodeProps props)

Method Summary

Modifier and Type	Method and Description
void	addBackend(Backend backend) Add a Virtual Services that this node is expected to send outbound traffic to.
void	addListener(VirtualNodeListener listener) Utility method to add an inbound listener for this VirtualNode.
static IVirtualNode	fromVirtualNodeArn(software.constructs.Construct scope, java.lang.String id, java.lang.String virtualNodeArn) Import an existing VirtualNode given an ARN.
static IVirtualNode	fromVirtualNodeAttributes(software.constructs.Construct scope, java.lang.String id, VirtualNodeAttributes attrs) Import an existing VirtualNode given its name.
IMesh	getMesh() The Mesh which the VirtualNode belongs to.
java.lang.String	getVirtualNodeArn() The Amazon Resource Name belonging to the VirtualNode.
java.lang.String	getVirtualNodeName() The name of the VirtualNode.
Grant	grantStreamAggregatedResources(IGrantable identity) Grants the given entity `appmesh:StreamAggregatedResources`.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

VirtualNode

protected VirtualNode(software.amazon.jsii.JsiiObjectRef objRef)

VirtualNode

protected VirtualNode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VirtualNode

public VirtualNode(software.constructs.Construct scope,
                   java.lang.String id,
                   VirtualNodeProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualNodeArn

public static IVirtualNode fromVirtualNodeArn(software.constructs.Construct scope,
                                              java.lang.String id,
                                              java.lang.String virtualNodeArn)

Import an existing VirtualNode given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

virtualNodeArn - This parameter is required.

fromVirtualNodeAttributes

public static IVirtualNode fromVirtualNodeAttributes(software.constructs.Construct scope,
                                                     java.lang.String id,
                                                     VirtualNodeAttributes attrs)

Import an existing VirtualNode given its name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addBackend

public void addBackend(Backend backend)

Add a Virtual Services that this node is expected to send outbound traffic to.

Parameters:

backend - This parameter is required.

addListener

public void addListener(VirtualNodeListener listener)

Utility method to add an inbound listener for this VirtualNode.

Note: At this time, Virtual Nodes support at most one listener. Adding more than one will result in a failure to deploy the CloudFormation stack. However, the App Mesh team has plans to add support for multiple listeners on Virtual Nodes and Virtual Routers.

Parameters:

listener - This parameter is required.

See Also:

https://github.com/aws/aws-app-mesh-roadmap/issues/120

grantStreamAggregatedResources

public Grant grantStreamAggregatedResources(IGrantable identity)

Grants the given entity `appmesh:StreamAggregatedResources`.

Specified by:

grantStreamAggregatedResources in interface IVirtualNode

Parameters:

identity - This parameter is required.

getMesh

public IMesh getMesh()

The Mesh which the VirtualNode belongs to.

Specified by:

getMesh in interface IVirtualNode

getVirtualNodeArn

public java.lang.String getVirtualNodeArn()

The Amazon Resource Name belonging to the VirtualNode.

Specified by:

getVirtualNodeArn in interface IVirtualNode

getVirtualNodeName

public java.lang.String getVirtualNodeName()

The name of the VirtualNode.

Specified by:

getVirtualNodeName in interface IVirtualNode