software.amazon.awscdk.services.appmesh

Class CfnMesh

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appmesh.CfnMesh

All Implemented Interfaces:

IInspectable, 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.464Z")
 @Stability(value=Stable)
public class CfnMesh
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::Mesh`.

Creates a service mesh.

A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

For more information about service meshes, see Service meshes .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 CfnMesh cfnMesh = CfnMesh.Builder.create(this, "MyCfnMesh")
         .meshName("meshName")
         .spec(MeshSpecProperty.builder()
                 .egressFilter(EgressFilterProperty.builder()
                         .type("type")
                         .build())
                 .serviceDiscovery(MeshServiceDiscoveryProperty.builder()
                         .ipPreference("ipPreference")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMesh.Builder A fluent builder for CfnMesh.
static interface	CfnMesh.EgressFilterProperty An object that represents the egress filter rules for a service mesh.
static interface	CfnMesh.MeshServiceDiscoveryProperty An object that represents the service discovery information for a service mesh.
static interface	CfnMesh.MeshSpecProperty An object that represents the specification of a service 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMesh(software.constructs.Construct scope, String id) Create a new `AWS::AppMesh::Mesh`.
	CfnMesh(software.constructs.Construct scope, String id, CfnMeshProps props) Create a new `AWS::AppMesh::Mesh`.
protected	CfnMesh(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMesh(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The full Amazon Resource Name (ARN) for the mesh.
String	getAttrMeshName() The name of the service mesh.
String	getAttrMeshOwner() The IAM account ID of the service mesh owner.
String	getAttrResourceOwner() The IAM account ID of the resource owner.
String	getAttrUid() The unique identifier for the mesh.
protected Map<String,Object>	getCfnProperties()
String	getMeshName() The name to use for the service mesh.
Object	getSpec() The service mesh specification to apply.
TagManager	getTags() Optional metadata that you can apply to the service mesh to assist with categorization and organization.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMeshName(String value) The name to use for the service mesh.
void	setSpec(CfnMesh.MeshSpecProperty value) The service mesh specification to apply.
void	setSpec(IResolvable value) The service mesh specification to apply.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMesh

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

CfnMesh

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

CfnMesh

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

Create a new `AWS::AppMesh::Mesh`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnMesh

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

Create a new `AWS::AppMesh::Mesh`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

The full Amazon Resource Name (ARN) for the mesh.

getAttrMeshName

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

The name of the service mesh.

getAttrMeshOwner

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

The IAM account ID of the service mesh owner.

If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

getAttrResourceOwner

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

The IAM account ID of the resource owner.

If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .

getAttrUid

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

The unique identifier for the mesh.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Optional metadata that you can apply to the service mesh to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

getMeshName

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

The name to use for the service mesh.

setMeshName

@Stability(value=Stable)
public void setMeshName(@Nullable
                                                 String value)

The name to use for the service mesh.

getSpec

@Stability(value=Stable)
 @Nullable
public Object getSpec()

The service mesh specification to apply.

setSpec

@Stability(value=Stable)
public void setSpec(@Nullable
                                             CfnMesh.MeshSpecProperty value)

The service mesh specification to apply.

setSpec

@Stability(value=Stable)
public void setSpec(@Nullable
                                             IResolvable value)

The service mesh specification to apply.