IMesh

class aws_cdk.aws_appmesh.IMesh(*args, **kwds)

Bases: aws_cdk.core.IResource, typing_extensions.Protocol

(experimental) Interface wich all Mesh based classes MUST implement.

Stability

experimental

Methods

add_virtual_gateway(id, *, access_log=None, listeners=None, virtual_gateway_name=None)

(experimental) Adds a VirtualGateway to the Mesh.

Parameters
  • id (str) –

  • access_log (Optional[AccessLog]) – (experimental) Access Logging Configuration for the VirtualGateway. Default: - no access logging

  • listeners (Optional[List[VirtualGatewayListener]]) – (experimental) Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080

  • virtual_gateway_name (Optional[str]) – (experimental) Name of the VirtualGateway. Default: - A name is automatically determined

Stability

experimental

Return type

VirtualGateway

add_virtual_node(id, *, access_log=None, backends=None, cloud_map_service=None, cloud_map_service_instance_attributes=None, dns_host_name=None, listeners=None, virtual_node_name=None)

(experimental) Adds a VirtualNode to the Mesh.

Parameters
  • id (str) –

  • access_log (Optional[AccessLog]) – (experimental) Access Logging Configuration for the virtual node. Default: - No access logging

  • backends (Optional[List[IVirtualService]]) – (experimental) Virtual Services that this is node expected to send outbound traffic to. Default: - No backends

  • cloud_map_service (Optional[IService]) – (experimental) CloudMap service where Virtual Node members register themselves. Instances registering themselves into this CloudMap will be considered part of the Virtual Node. Default: - Don’t use CloudMap-based service discovery

  • cloud_map_service_instance_attributes (Optional[Mapping[str, str]]) – (experimental) Filter down the list of CloudMap service instance. Default: - No CloudMap instance filter

  • dns_host_name (Optional[str]) – (experimental) Host name of DNS record used to discover Virtual Node members. The IP addresses returned by querying this DNS record will be considered part of the Virtual Node. Default: - Don’t use DNS-based service discovery

  • listeners (Optional[List[VirtualNodeListener]]) – (experimental) Initial listener for the virtual node. Default: - No listeners

  • virtual_node_name (Optional[str]) – (experimental) The name of the VirtualNode. Default: - A name is automatically determined

Stability

experimental

Return type

VirtualNode

add_virtual_router(id, *, listeners=None, virtual_router_name=None)

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

Parameters
  • id (str) –

  • listeners (Optional[List[VirtualRouterListener]]) – (experimental) Listener specification for the VirtualRouter. Default: - A listener on HTTP port 8080

  • virtual_router_name (Optional[str]) – (experimental) The name of the VirtualRouter. Default: - A name is automatically determined

Stability

experimental

Return type

VirtualRouter

add_virtual_service(id, *, virtual_node=None, virtual_router=None, virtual_service_name=None)

(experimental) Adds a VirtualService with the given id.

Parameters
  • id (str) –

  • virtual_node (Optional[IVirtualNode]) – (experimental) The VirtualNode attached to the virtual service. Default: - At most one of virtualRouter and virtualNode is allowed.

  • virtual_router (Optional[IVirtualRouter]) – (experimental) The VirtualRouter which the VirtualService uses as provider. Default: - At most one of virtualRouter and virtualNode is allowed.

  • virtual_service_name (Optional[str]) – (experimental) The name of the VirtualService. It is recommended this follows the fully-qualified domain name format, such as “my-service.default.svc.cluster.local”. Default: - A name is automatically generated

Stability

experimental

Return type

VirtualService

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

mesh_arn

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

Stability

experimental

Attribute

true

Return type

str

mesh_name

(experimental) The name of the AppMesh mesh.

Stability

experimental

Attribute

true

Return type

str

node

The construct tree node for this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack