Mesh¶
-
class
aws_cdk.aws_appmesh.
Mesh
(scope, id, *, egress_filter=None, mesh_name=None)¶ Bases:
aws_cdk.core.Resource
(experimental) Define a new AppMesh mesh.
- See
https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html
- Stability
experimental
- Parameters
scope (
Construct
) –id (
str
) –egress_filter (
Optional
[MeshFilterType
]) – (experimental) Egress filter to be applied to the Mesh. Default: DROP_ALLmesh_name (
Optional
[str
]) – (experimental) The name of the Mesh being defined. Default: - A name is autmoatically generated
- Stability
experimental
Methods
-
add_virtual_gateway
(id, *, access_log=None, backends_default_client_policy=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 loggingbackends_default_client_policy (
Optional
[ClientPolicy
]) – (experimental) Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Configlisteners (
Optional
[List
[VirtualGatewayListener
]]) – (experimental) Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080virtual_gateway_name (
Optional
[str
]) – (experimental) Name of the VirtualGateway. Default: - A name is automatically determined
- Stability
experimental
- Return type
-
add_virtual_node
(id, *, access_log=None, backends=None, backends_default_client_policy=None, listeners=None, service_discovery=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 loggingbackends (
Optional
[List
[IVirtualService
]]) – (experimental) Virtual Services that this is node expected to send outbound traffic to. Default: - No backendsbackends_default_client_policy (
Optional
[ClientPolicy
]) – (experimental) Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Configlisteners (
Optional
[List
[VirtualNodeListener
]]) – (experimental) Initial listener for the virtual node. Default: - No listenersservice_discovery (
Optional
[ServiceDiscovery
]) – (experimental) Defines how upstream clients will discover this VirtualNode. Default: - No Service Discoveryvirtual_node_name (
Optional
[str
]) – (experimental) The name of the VirtualNode. Default: - A name is automatically determined
- Stability
experimental
- Return type
-
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 8080virtual_router_name (
Optional
[str
]) – (experimental) The name of the VirtualRouter. Default: - A name is automatically determined
- Stability
experimental
- Return type
-
add_virtual_service
(id, *, client_policy=None, virtual_node=None, virtual_router=None, virtual_service_name=None)¶ (experimental) Adds a VirtualService with the given id.
- Parameters
id (
str
) –client_policy (
Optional
[ClientPolicy
]) – (experimental) Client policy for this Virtual Service. Default: - nonevirtual_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
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
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
-
mesh_arn
¶ (experimental) The Amazon Resource Name (ARN) of the AppMesh mesh.
- Stability
experimental
- Return type
str
-
mesh_name
¶ (experimental) The name of the AppMesh mesh.
- Stability
experimental
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_mesh_arn
(scope, id, mesh_arn)¶ (experimental) Import an existing mesh by arn.
- Parameters
scope (
Construct
) –id (
str
) –mesh_arn (
str
) –
- Stability
experimental
- Return type
-
classmethod
from_mesh_name
(scope, id, mesh_name)¶ (experimental) Import an existing mesh by name.
- Parameters
scope (
Construct
) –id (
str
) –mesh_name (
str
) –
- Stability
experimental
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool