Package software.amazon.awscdk.services.appmesh

Class CfnMesh

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appmesh.CfnMesh
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.804Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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(Stable) public CfnMesh(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The full Amazon Resource Name (ARN) for the mesh.

    • getAttrMeshName

      @Stability(Stable) @NotNull public String getAttrMeshName()
      The name of the service mesh.

    • getAttrMeshOwner

      @Stability(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(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(Stable) @NotNull public String getAttrUid()
      The unique identifier for the mesh.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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(Stable) @Nullable public String getMeshName()
      The name to use for the service mesh.

    • setMeshName

      @Stability(Stable) public void setMeshName(@Nullable String value)
      The name to use for the service mesh.

    • getSpec

      @Stability(Stable) @Nullable public Object getSpec()
      The service mesh specification to apply.

    • setSpec

      @Stability(Stable) public void setSpec(@Nullable IResolvable value)
      The service mesh specification to apply.

    • setSpec

      @Stability(Stable) public void setSpec(@Nullable CfnMesh.MeshSpecProperty value)
      The service mesh specification to apply.