aws_app_mesh
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices.
App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, and Amazon EC2.
App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kuberneteskube-dns
and coredns
are
supported. For more information, see DNS for Services and Pods in the
Kubernetes documentation.
Summary
Functions
-
create_gateway_route(Client, MeshName, VirtualGatewayName, Input)
Creates a gateway route.
- create_gateway_route(Client, MeshName, VirtualGatewayName, Input0, Options0)
-
create_mesh(Client, Input)
Creates a service mesh.
- create_mesh(Client, Input0, Options0)
-
create_route(Client, MeshName, VirtualRouterName, Input)
Creates a route that is associated with a virtual router.
- create_route(Client, MeshName, VirtualRouterName, Input0, Options0)
-
create_virtual_gateway(Client, MeshName, Input)
Creates a virtual gateway.
- create_virtual_gateway(Client, MeshName, Input0, Options0)
-
create_virtual_node(Client, MeshName, Input)
Creates a virtual node within a service mesh.
- create_virtual_node(Client, MeshName, Input0, Options0)
-
create_virtual_router(Client, MeshName, Input)
Creates a virtual router within a service mesh.
- create_virtual_router(Client, MeshName, Input0, Options0)
-
create_virtual_service(Client, MeshName, Input)
Creates a virtual service within a service mesh.
- create_virtual_service(Client, MeshName, Input0, Options0)
-
delete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input)
Deletes an existing gateway route.
- delete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input0, Options0)
-
delete_mesh(Client, MeshName, Input)
Deletes an existing service mesh.
- delete_mesh(Client, MeshName, Input0, Options0)
-
delete_route(Client, MeshName, RouteName, VirtualRouterName, Input)
Deletes an existing route.
- delete_route(Client, MeshName, RouteName, VirtualRouterName, Input0, Options0)
-
delete_virtual_gateway(Client, MeshName, VirtualGatewayName, Input)
Deletes an existing virtual gateway.
- delete_virtual_gateway(Client, MeshName, VirtualGatewayName, Input0, Options0)
-
delete_virtual_node(Client, MeshName, VirtualNodeName, Input)
Deletes an existing virtual node.
- delete_virtual_node(Client, MeshName, VirtualNodeName, Input0, Options0)
-
delete_virtual_router(Client, MeshName, VirtualRouterName, Input)
Deletes an existing virtual router.
- delete_virtual_router(Client, MeshName, VirtualRouterName, Input0, Options0)
-
delete_virtual_service(Client, MeshName, VirtualServiceName, Input)
Deletes an existing virtual service.
- delete_virtual_service(Client, MeshName, VirtualServiceName, Input0, Options0)
-
describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName)
Describes an existing gateway route.
- describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
- describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
-
describe_mesh(Client, MeshName)
Describes an existing service mesh.
- describe_mesh(Client, MeshName, QueryMap, HeadersMap)
- describe_mesh(Client, MeshName, QueryMap, HeadersMap, Options0)
-
describe_route(Client, MeshName, RouteName, VirtualRouterName)
Describes an existing route.
- describe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap)
- describe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap, Options0)
-
describe_virtual_gateway(Client, MeshName, VirtualGatewayName)
Describes an existing virtual gateway.
- describe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
- describe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
-
describe_virtual_node(Client, MeshName, VirtualNodeName)
Describes an existing virtual node.
- describe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap)
- describe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap, Options0)
-
describe_virtual_router(Client, MeshName, VirtualRouterName)
Describes an existing virtual router.
- describe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
- describe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
-
describe_virtual_service(Client, MeshName, VirtualServiceName)
Describes an existing virtual service.
- describe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap)
- describe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap, Options0)
-
list_gateway_routes(Client, MeshName, VirtualGatewayName)
Returns a list of existing gateway routes that are associated to a virtual gateway.
- list_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
- list_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
-
list_meshes(Client)
Returns a list of existing service meshes.
- list_meshes(Client, QueryMap, HeadersMap)
- list_meshes(Client, QueryMap, HeadersMap, Options0)
-
list_routes(Client, MeshName, VirtualRouterName)
Returns a list of existing routes in a service mesh.
- list_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
- list_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
List the tags for an App Mesh resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
list_virtual_gateways(Client, MeshName)
Returns a list of existing virtual gateways in a service mesh.
- list_virtual_gateways(Client, MeshName, QueryMap, HeadersMap)
- list_virtual_gateways(Client, MeshName, QueryMap, HeadersMap, Options0)
-
list_virtual_nodes(Client, MeshName)
Returns a list of existing virtual nodes.
- list_virtual_nodes(Client, MeshName, QueryMap, HeadersMap)
- list_virtual_nodes(Client, MeshName, QueryMap, HeadersMap, Options0)
-
list_virtual_routers(Client, MeshName)
Returns a list of existing virtual routers in a service mesh.
- list_virtual_routers(Client, MeshName, QueryMap, HeadersMap)
- list_virtual_routers(Client, MeshName, QueryMap, HeadersMap, Options0)
-
list_virtual_services(Client, MeshName)
Returns a list of existing virtual services in a service mesh.
- list_virtual_services(Client, MeshName, QueryMap, HeadersMap)
- list_virtual_services(Client, MeshName, QueryMap, HeadersMap, Options0)
-
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
. - tag_resource(Client, Input0, Options0)
-
untag_resource(Client, Input)
Deletes specified tags from a resource.
- untag_resource(Client, Input0, Options0)
-
update_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
- update_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input0, Options0)
-
update_mesh(Client, MeshName, Input)
Updates an existing service mesh.
- update_mesh(Client, MeshName, Input0, Options0)
-
update_route(Client, MeshName, RouteName, VirtualRouterName, Input)
Updates an existing route for a specified service mesh and virtual router.
- update_route(Client, MeshName, RouteName, VirtualRouterName, Input0, Options0)
-
update_virtual_gateway(Client, MeshName, VirtualGatewayName, Input)
Updates an existing virtual gateway in a specified service mesh.
- update_virtual_gateway(Client, MeshName, VirtualGatewayName, Input0, Options0)
-
update_virtual_node(Client, MeshName, VirtualNodeName, Input)
Updates an existing virtual node in a specified service mesh.
- update_virtual_node(Client, MeshName, VirtualNodeName, Input0, Options0)
-
update_virtual_router(Client, MeshName, VirtualRouterName, Input)
Updates an existing virtual router in a specified service mesh.
- update_virtual_router(Client, MeshName, VirtualRouterName, Input0, Options0)
-
update_virtual_service(Client, MeshName, VirtualServiceName, Input)
Updates an existing virtual service in a specified service mesh.
- update_virtual_service(Client, MeshName, VirtualServiceName, Input0, Options0)
Functions
create_gateway_route(Client, MeshName, VirtualGatewayName, Input)
Creates a gateway route.
A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.
For more information about gateway routes, see Gateway routes.create_gateway_route(Client, MeshName, VirtualGatewayName, Input0, Options0)
create_mesh(Client, Input)
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.create_mesh(Client, Input0, Options0)
create_route(Client, MeshName, VirtualRouterName, Input)
Creates a route that is associated with a virtual router.
You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.
For more information about routes, see Routes.create_route(Client, MeshName, VirtualRouterName, Input0, Options0)
create_virtual_gateway(Client, MeshName, Input)
Creates a virtual gateway.
A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
For more information about virtual gateways, see Virtual gateways.create_virtual_gateway(Client, MeshName, Input0, Options0)
create_virtual_node(Client, MeshName, Input)
Creates a virtual node within a service mesh.
A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).
You define a listener
for any inbound traffic that your virtual node
expects. Any virtual service that your virtual node expects to communicate
to is specified as a backend
.
The response metadata for your new virtual node contains the arn
that is
associated with the virtual node. Set this value to the full ARN; for
example,
arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp
)
as the APPMESH_RESOURCE_ARN
environment variable for your task group's
Envoy proxy container in your task definition or pod spec. This is then
mapped to the node.id
and node.cluster
Envoy parameters.
By default, App Mesh uses the name of the resource you specified in
APPMESH_RESOURCE_ARN
when Envoy is referring to itself in metrics and
traces. You can override this behavior by setting the
APPMESH_RESOURCE_CLUSTER
environment variable with your own name.
AWS Cloud Map is not available in the eu-south-1 Region.
For more information about virtual nodes, see Virtual nodes. You must be using1.15.0
or later of the Envoy image when setting these variables.
For more information about App Mesh Envoy variables, see Envoy image in
the AWS App Mesh User Guide.
create_virtual_node(Client, MeshName, Input0, Options0)
create_virtual_router(Client, MeshName, Input)
Creates a virtual router within a service mesh.
Specify a listener
for any inbound traffic that your virtual router
receives. Create a virtual router for each protocol and port that you need
to route. Virtual routers handle traffic for one or more virtual services
within your mesh. After you create your virtual router, create and
associate routes for your virtual router that direct incoming requests to
different virtual nodes.
create_virtual_router(Client, MeshName, Input0, Options0)
create_virtual_service(Client, MeshName, Input)
Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by
a virtual node directly or indirectly by means of a virtual router.
Dependent services call your virtual service by its virtualServiceName
,
and those requests are routed to the virtual node or virtual router that
is specified as the provider for the virtual service.
create_virtual_service(Client, MeshName, Input0, Options0)
delete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input)
Deletes an existing gateway route.
delete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input0, Options0)
delete_mesh(Client, MeshName, Input)
Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.delete_mesh(Client, MeshName, Input0, Options0)
delete_route(Client, MeshName, RouteName, VirtualRouterName, Input)
Deletes an existing route.
delete_route(Client, MeshName, RouteName, VirtualRouterName, Input0, Options0)
delete_virtual_gateway(Client, MeshName, VirtualGatewayName, Input)
Deletes an existing virtual gateway.
You cannot delete a virtual gateway if any gateway routes are associated to it.delete_virtual_gateway(Client, MeshName, VirtualGatewayName, Input0, Options0)
delete_virtual_node(Client, MeshName, VirtualNodeName, Input)
Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.delete_virtual_node(Client, MeshName, VirtualNodeName, Input0, Options0)
delete_virtual_router(Client, MeshName, VirtualRouterName, Input)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.delete_virtual_router(Client, MeshName, VirtualRouterName, Input0, Options0)
delete_virtual_service(Client, MeshName, VirtualServiceName, Input)
Deletes an existing virtual service.
delete_virtual_service(Client, MeshName, VirtualServiceName, Input0, Options0)
describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName)
Describes an existing gateway route.
describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
describe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
describe_mesh(Client, MeshName)
Describes an existing service mesh.
describe_mesh(Client, MeshName, QueryMap, HeadersMap)
describe_mesh(Client, MeshName, QueryMap, HeadersMap, Options0)
describe_route(Client, MeshName, RouteName, VirtualRouterName)
Describes an existing route.
describe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap)
describe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap, Options0)
describe_virtual_gateway(Client, MeshName, VirtualGatewayName)
Describes an existing virtual gateway.
describe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
describe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
describe_virtual_node(Client, MeshName, VirtualNodeName)
Describes an existing virtual node.
describe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap)
describe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap, Options0)
describe_virtual_router(Client, MeshName, VirtualRouterName)
Describes an existing virtual router.
describe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
describe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
describe_virtual_service(Client, MeshName, VirtualServiceName)
Describes an existing virtual service.
describe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap)
describe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap, Options0)
list_gateway_routes(Client, MeshName, VirtualGatewayName)
Returns a list of existing gateway routes that are associated to a virtual gateway.
list_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
list_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
list_meshes(Client)
Returns a list of existing service meshes.
list_meshes(Client, QueryMap, HeadersMap)
list_meshes(Client, QueryMap, HeadersMap, Options0)
list_routes(Client, MeshName, VirtualRouterName)
Returns a list of existing routes in a service mesh.
list_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
list_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
List the tags for an App Mesh resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
list_virtual_gateways(Client, MeshName)
Returns a list of existing virtual gateways in a service mesh.
list_virtual_gateways(Client, MeshName, QueryMap, HeadersMap)
list_virtual_gateways(Client, MeshName, QueryMap, HeadersMap, Options0)
list_virtual_nodes(Client, MeshName)
Returns a list of existing virtual nodes.
list_virtual_nodes(Client, MeshName, QueryMap, HeadersMap)
list_virtual_nodes(Client, MeshName, QueryMap, HeadersMap, Options0)
list_virtual_routers(Client, MeshName)
Returns a list of existing virtual routers in a service mesh.
list_virtual_routers(Client, MeshName, QueryMap, HeadersMap)
list_virtual_routers(Client, MeshName, QueryMap, HeadersMap, Options0)
list_virtual_services(Client, MeshName)
Returns a list of existing virtual services in a service mesh.
list_virtual_services(Client, MeshName, QueryMap, HeadersMap)
list_virtual_services(Client, MeshName, QueryMap, HeadersMap, Options0)
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
.
tag_resource(Client, Input0, Options0)
untag_resource(Client, Input)
Deletes specified tags from a resource.
untag_resource(Client, Input0, Options0)
update_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
update_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input0, Options0)
update_mesh(Client, MeshName, Input)
Updates an existing service mesh.
update_mesh(Client, MeshName, Input0, Options0)
update_route(Client, MeshName, RouteName, VirtualRouterName, Input)
Updates an existing route for a specified service mesh and virtual router.
update_route(Client, MeshName, RouteName, VirtualRouterName, Input0, Options0)
update_virtual_gateway(Client, MeshName, VirtualGatewayName, Input)
Updates an existing virtual gateway in a specified service mesh.
update_virtual_gateway(Client, MeshName, VirtualGatewayName, Input0, Options0)
update_virtual_node(Client, MeshName, VirtualNodeName, Input)
Updates an existing virtual node in a specified service mesh.
update_virtual_node(Client, MeshName, VirtualNodeName, Input0, Options0)
update_virtual_router(Client, MeshName, VirtualRouterName, Input)
Updates an existing virtual router in a specified service mesh.
update_virtual_router(Client, MeshName, VirtualRouterName, Input0, Options0)
update_virtual_service(Client, MeshName, VirtualServiceName, Input)
Updates an existing virtual service in a specified service mesh.