Skip to content
v2.273.0

IMesh Interface ​

Interface which all Mesh based classes MUST implement.

Properties ​

The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

meshArnstringmesh_arnstrmeshArnStringMeshArnstringMeshArn*stringrequired#
The Amazon Resource Name (ARN) of the AppMesh mesh.
meshNamestringmesh_namestrmeshNameStringMeshNamestringMeshName*stringrequired#
The name of the AppMesh mesh.
meshRefMeshReferencemesh_refMeshReferencemeshRefMeshReferenceMeshRefMeshReferenceMeshRefMeshReferencerequired#
A reference to a Mesh resource.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

addVirtualGateway(id: string, props?: VirtualGatewayBaseProps): VirtualGatewaydef add_virtual_gateway(self, id: str, props: typing.Optional[VirtualGatewayBaseProps] = None) -> VirtualGatewaypublic VirtualGateway addVirtualGateway(String id, VirtualGatewayBaseProps props)public VirtualGateway AddVirtualGateway(string id, VirtualGatewayBaseProps? props = null)func AddVirtualGateway(Id *string, Props VirtualGatewayBaseProps) VirtualGateway#
Creates a new VirtualGateway in this Mesh.

Note that the Gateway is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

addVirtualNode(id: string, props?: VirtualNodeBaseProps): VirtualNodedef add_virtual_node(self, id: str, props: typing.Optional[VirtualNodeBaseProps] = None) -> VirtualNodepublic VirtualNode addVirtualNode(String id, VirtualNodeBaseProps props)public VirtualNode AddVirtualNode(string id, VirtualNodeBaseProps? props = null)func AddVirtualNode(Id *string, Props VirtualNodeBaseProps) VirtualNode#
Creates a new VirtualNode in this Mesh.

Note that the Node is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

addVirtualRouter(id: string, props?: VirtualRouterBaseProps): VirtualRouterdef add_virtual_router(self, id: str, props: typing.Optional[VirtualRouterBaseProps] = None) -> VirtualRouterpublic VirtualRouter addVirtualRouter(String id, VirtualRouterBaseProps props)public VirtualRouter AddVirtualRouter(string id, VirtualRouterBaseProps? props = null)func AddVirtualRouter(Id *string, Props VirtualRouterBaseProps) VirtualRouter#
Creates a new VirtualRouter in this Mesh.

Note that the Router is created in the same Stack that this Mesh belongs to, which might be different than the current stack.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining