Class CfnMesh
- All Implemented Interfaces:
IInspectable,ITaggable,IMeshRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnMesh.static interfaceAn object that represents the egress filter rules for a service mesh.static interfaceAn object that represents the service discovery information for a service mesh.static interfaceAn object that represents the specification of a service mesh.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.appmesh.IMeshRef
IMeshRef.Jsii$Default, IMeshRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnMesh(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnMesh(software.amazon.jsii.JsiiObjectRef objRef) CfnMesh(software.constructs.Construct scope, String id, CfnMeshProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe full Amazon Resource Name (ARN) for the mesh.The name of the service mesh.The IAM account ID of the service mesh owner.The IAM account ID of the resource owner.The unique identifier for the mesh.The name to use for the service mesh.A reference to a Mesh resource.getSpec()The service mesh specification to apply.getTags()Tag Manager which manages the tags for this resource.Optional metadata that you can apply to the service mesh to assist with categorization and organization.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetMeshName(String value) The name to use for the service mesh.voidsetSpec(IResolvable value) The service mesh specification to apply.voidsetSpec(CfnMesh.MeshSpecProperty value) The service mesh specification to apply.voidsetTagsRaw(List<CfnTag> value) Optional metadata that you can apply to the service mesh to assist with categorization and organization.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnMesh
protected CfnMesh(software.amazon.jsii.JsiiObjectRef objRef) -
CfnMesh
protected CfnMesh(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnMesh
@Stability(Stable) public CfnMesh(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnMeshProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties.
-
CfnMesh
- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The full Amazon Resource Name (ARN) for the mesh. -
getAttrId
-
getAttrMeshName
The name of the service mesh. -
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
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
The unique identifier for the mesh. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getMeshRef
A reference to a Mesh resource.- Specified by:
getMeshRefin interfaceIMeshRef
-
getTags
Tag Manager which manages the tags for this resource. -
getMeshName
The name to use for the service mesh. -
setMeshName
The name to use for the service mesh. -
getSpec
The service mesh specification to apply. -
setSpec
The service mesh specification to apply. -
setSpec
The service mesh specification to apply. -
getTagsRaw
Optional metadata that you can apply to the service mesh to assist with categorization and organization. -
setTagsRaw
Optional metadata that you can apply to the service mesh to assist with categorization and organization.
-