software.amazon.awscdk.services.appmesh

Class VirtualNode

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.VirtualNode

All Implemented Interfaces:

IResource, IVirtualNode, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.584Z")
 @Stability(value=Stable)
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:

 // Example automatically generated from non-compiling source. May contain errors.
 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	VirtualNode(software.constructs.Construct scope, String id, VirtualNodeProps props)
protected	VirtualNode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VirtualNode(software.amazon.jsii.JsiiObjectRef objRef)

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, String id, String virtualNodeArn) Import an existing VirtualNode given an ARN.
static IVirtualNode	fromVirtualNodeAttributes(software.constructs.Construct scope, String id, VirtualNodeAttributes attrs) Import an existing VirtualNode given its name.
IMesh	getMesh() The Mesh which the VirtualNode belongs to.
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 class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VirtualNode

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

VirtualNode

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

VirtualNode

@Stability(value=Stable)
public VirtualNode(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            VirtualNodeProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualNodeArn

@Stability(value=Stable)
 @NotNull
public static IVirtualNode fromVirtualNodeArn(@NotNull
                                                                                 software.constructs.Construct scope,
                                                                                 @NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 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

@Stability(value=Stable)
 @NotNull
public static IVirtualNode fromVirtualNodeAttributes(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        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

@Stability(value=Stable)
public void addBackend(@NotNull
                                                Backend backend)

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

Parameters:

backend - This parameter is required.

addListener

@Stability(value=Stable)
public void addListener(@NotNull
                                                 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

@Stability(value=Stable)
 @NotNull
public Grant grantStreamAggregatedResources(@NotNull
                                                                               IGrantable identity)

Grants the given entity `appmesh:StreamAggregatedResources`.

Specified by:

grantStreamAggregatedResources in interface IVirtualNode

Parameters:

identity - This parameter is required.

getMesh

@Stability(value=Stable)
 @NotNull
public IMesh getMesh()

The Mesh which the VirtualNode belongs to.

Specified by:

getMesh in interface IVirtualNode

getVirtualNodeArn

@Stability(value=Stable)
 @NotNull
public String getVirtualNodeArn()

The Amazon Resource Name belonging to the VirtualNode.

Specified by:

getVirtualNodeArn in interface IVirtualNode

getVirtualNodeName

@Stability(value=Stable)
 @NotNull
public String getVirtualNodeName()

The name of the VirtualNode.

Specified by:

getVirtualNodeName in interface IVirtualNode