View Source aws_app_mesh (aws v1.0.4)
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 Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, 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: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html in the Amazon Elastic Container Service Developer Guide. Kuberneteskube-dns
and coredns
are supported. For more information, see DNS for Services and Pods: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ in the Kubernetes documentation.
Summary
Functions
Creates a gateway route.
Creates a service mesh.
Creates a route that is associated with a virtual router.
Creates a virtual gateway.
Creates a virtual node within a service mesh.
Creates a virtual router within a service mesh.
Creates a virtual service within a service mesh.
Deletes an existing service mesh.
Deletes an existing virtual gateway.
Deletes an existing virtual node.
Deletes an existing virtual router.
Associates the specified tags to a resource with the specified resourceArn
.
Functions
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: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html.create_gateway_route(Client, MeshName, VirtualGatewayName, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html.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: https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html.create_route(Client, MeshName, VirtualRouterName, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html.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.
1.15.0
or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image: https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html in the App Mesh User Guide.
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.
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.
delete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input)
View Sourcedelete_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, Input0, Options0)
View SourceDeletes 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_route(Client, MeshName, RouteName, VirtualRouterName, Input)
View Sourcedelete_route(Client, MeshName, RouteName, VirtualRouterName, Input0, Options0)
View Sourcedelete_virtual_gateway(Client, MeshName, VirtualGatewayName, Input)
View SourceDeletes 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)
View SourceDeletes 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)
View SourceDeletes 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)
View Sourcedelete_virtual_service(Client, MeshName, VirtualServiceName, Input)
View Sourcedelete_virtual_service(Client, MeshName, VirtualServiceName, Input0, Options0)
View Sourcedescribe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName)
View Sourcedescribe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
View Sourcedescribe_gateway_route(Client, GatewayRouteName, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap)
View Sourcedescribe_route(Client, MeshName, RouteName, VirtualRouterName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
View Sourcedescribe_virtual_gateway(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap)
View Sourcedescribe_virtual_node(Client, MeshName, VirtualNodeName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
View Sourcedescribe_virtual_router(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap)
View Sourcedescribe_virtual_service(Client, MeshName, VirtualServiceName, QueryMap, HeadersMap, Options0)
View Sourcelist_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap)
View Sourcelist_gateway_routes(Client, MeshName, VirtualGatewayName, QueryMap, HeadersMap, Options0)
View Sourcelist_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap)
View Sourcelist_routes(Client, MeshName, VirtualRouterName, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcelist_virtual_gateways(Client, MeshName, QueryMap, HeadersMap, Options0)
View Sourcelist_virtual_nodes(Client, MeshName, QueryMap, HeadersMap, Options0)
View Sourcelist_virtual_routers(Client, MeshName, QueryMap, HeadersMap, Options0)
View Sourcelist_virtual_services(Client, MeshName, QueryMap, HeadersMap, Options0)
View SourceAssociates the specified tags to a resource with the specified resourceArn
.