software.amazon.awscdk.services.appmesh

Class Mesh

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.Mesh

All Implemented Interfaces:

IResource, IMesh, 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.566Z")
 @Stability(value=Stable)
public class Mesh
extends Resource
implements IMesh

Define a new AppMesh mesh.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 // This is the ARN for the mesh from different AWS IAM account ID.
 // Ensure mesh is properly shared with your account. For more details, see: https://github.com/aws/aws-cdk/issues/15404
 String arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh";
 IMesh sharedMesh = Mesh.fromMeshArn(this, "imported-mesh", arn);
 // This VirtualNode resource can communicate with the resources in the mesh from different AWS IAM account ID.
 // This VirtualNode resource can communicate with the resources in the mesh from different AWS IAM account ID.
 VirtualNode.Builder.create(this, "test-node")
         .mesh(sharedMesh)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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.IMesh

IMesh.Jsii$Default, IMesh.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Mesh(software.constructs.Construct scope, String id)
	Mesh(software.constructs.Construct scope, String id, MeshProps props)
protected	Mesh(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Mesh(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
VirtualGateway	addVirtualGateway(String id) Adds a VirtualGateway to the Mesh.
VirtualGateway	addVirtualGateway(String id, VirtualGatewayBaseProps props) Adds a VirtualGateway to the Mesh.
VirtualNode	addVirtualNode(String id) Adds a VirtualNode to the Mesh.
VirtualNode	addVirtualNode(String id, VirtualNodeBaseProps props) Adds a VirtualNode to the Mesh.
VirtualRouter	addVirtualRouter(String id) Adds a VirtualRouter to the Mesh with the given id and props.
VirtualRouter	addVirtualRouter(String id, VirtualRouterBaseProps props) Adds a VirtualRouter to the Mesh with the given id and props.
static IMesh	fromMeshArn(software.constructs.Construct scope, String id, String meshArn) Import an existing mesh by arn.
static IMesh	fromMeshName(software.constructs.Construct scope, String id, String meshName) Import an existing mesh by name.
String	getMeshArn() The Amazon Resource Name (ARN) of the AppMesh mesh.
String	getMeshName() The name of the AppMesh mesh.

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

Mesh

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

Mesh

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

Mesh

@Stability(value=Stable)
public Mesh(@NotNull
                                     software.constructs.Construct scope,
                                     @NotNull
                                     String id,
                                     @Nullable
                                     MeshProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Mesh

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromMeshArn

@Stability(value=Stable)
 @NotNull
public static IMesh fromMeshArn(@NotNull
                                                                   software.constructs.Construct scope,
                                                                   @NotNull
                                                                   String id,
                                                                   @NotNull
                                                                   String meshArn)

Import an existing mesh by arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

meshArn - This parameter is required.

fromMeshName

@Stability(value=Stable)
 @NotNull
public static IMesh fromMeshName(@NotNull
                                                                    software.constructs.Construct scope,
                                                                    @NotNull
                                                                    String id,
                                                                    @NotNull
                                                                    String meshName)

Import an existing mesh by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

meshName - This parameter is required.

addVirtualGateway

@Stability(value=Stable)
 @NotNull
public VirtualGateway addVirtualGateway(@NotNull
                                                                           String id,
                                                                           @Nullable
                                                                           VirtualGatewayBaseProps props)

Adds a VirtualGateway to the Mesh.

Specified by:

addVirtualGateway in interface IMesh

Parameters:

id - This parameter is required.

props -

addVirtualGateway

@Stability(value=Stable)
 @NotNull
public VirtualGateway addVirtualGateway(@NotNull
                                                                           String id)

Adds a VirtualGateway to the Mesh.

Specified by:

addVirtualGateway in interface IMesh

Parameters:

id - This parameter is required.

addVirtualNode

@Stability(value=Stable)
 @NotNull
public VirtualNode addVirtualNode(@NotNull
                                                                     String id,
                                                                     @Nullable
                                                                     VirtualNodeBaseProps props)

Adds a VirtualNode to the Mesh.

Specified by:

addVirtualNode in interface IMesh

Parameters:

id - This parameter is required.

props -

addVirtualNode

@Stability(value=Stable)
 @NotNull
public VirtualNode addVirtualNode(@NotNull
                                                                     String id)

Adds a VirtualNode to the Mesh.

Specified by:

addVirtualNode in interface IMesh

Parameters:

id - This parameter is required.

addVirtualRouter

@Stability(value=Stable)
 @NotNull
public VirtualRouter addVirtualRouter(@NotNull
                                                                         String id,
                                                                         @Nullable
                                                                         VirtualRouterBaseProps props)

Adds a VirtualRouter to the Mesh with the given id and props.

Specified by:

addVirtualRouter in interface IMesh

Parameters:

id - This parameter is required.

props -

addVirtualRouter

@Stability(value=Stable)
 @NotNull
public VirtualRouter addVirtualRouter(@NotNull
                                                                         String id)

Adds a VirtualRouter to the Mesh with the given id and props.

Specified by:

addVirtualRouter in interface IMesh

Parameters:

id - This parameter is required.

getMeshArn

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

The Amazon Resource Name (ARN) of the AppMesh mesh.

Specified by:

getMeshArn in interface IMesh

getMeshName

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

The name of the AppMesh mesh.

Specified by:

getMeshName in interface IMesh