AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing AppMesh 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. Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.

Inheritance Hierarchy

Amazon.AppMesh.IAmazonAppMesh

Namespace: Amazon.AppMesh
Assembly: AWSSDK.AppMesh.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonAppMesh
         IAmazonService, IDisposable

The IAmazonAppMesh type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateMesh(CreateMeshRequest)

Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

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.

Public Method CreateMeshAsync(CreateMeshRequest, CancellationToken)

Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

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.

Public Method CreateRoute(CreateRouteRequest)

Creates a route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

For more information about routes, see Routes.

Public Method CreateRouteAsync(CreateRouteRequest, CancellationToken)

Creates a route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

For more information about routes, see Routes.

Public Method CreateVirtualNode(CreateVirtualNodeRequest)

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.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be 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 (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME 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.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

For more information about virtual nodes, see Virtual Nodes.

Public Method CreateVirtualNodeAsync(CreateVirtualNodeRequest, CancellationToken)

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.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be 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 (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME 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.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

For more information about virtual nodes, see Virtual Nodes.

Public Method CreateVirtualRouter(CreateVirtualRouterRequest)

Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener.

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.

For more information about virtual routers, see Virtual Routers.

Public Method CreateVirtualRouterAsync(CreateVirtualRouterRequest, CancellationToken)

Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener.

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.

For more information about virtual routers, see Virtual Routers.

Public Method CreateVirtualService(CreateVirtualServiceRequest)

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.

For more information about virtual services, see Virtual Services.

Public Method CreateVirtualServiceAsync(CreateVirtualServiceRequest, CancellationToken)

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.

For more information about virtual services, see Virtual Services.

Public Method DeleteMesh(DeleteMeshRequest)

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.

Public Method DeleteMeshAsync(DeleteMeshRequest, CancellationToken)

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.

Public Method DeleteRoute(DeleteRouteRequest)

Deletes an existing route.

Public Method DeleteRouteAsync(DeleteRouteRequest, CancellationToken)

Deletes an existing route.

Public Method DeleteVirtualNode(DeleteVirtualNodeRequest)

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.

Public Method DeleteVirtualNodeAsync(DeleteVirtualNodeRequest, CancellationToken)

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.

Public Method DeleteVirtualRouter(DeleteVirtualRouterRequest)

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Public Method DeleteVirtualRouterAsync(DeleteVirtualRouterRequest, CancellationToken)

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Public Method DeleteVirtualService(DeleteVirtualServiceRequest)

Deletes an existing virtual service.

Public Method DeleteVirtualServiceAsync(DeleteVirtualServiceRequest, CancellationToken)

Deletes an existing virtual service.

Public Method DescribeMesh(DescribeMeshRequest)

Describes an existing service mesh.

Public Method DescribeMeshAsync(DescribeMeshRequest, CancellationToken)

Describes an existing service mesh.

Public Method DescribeRoute(DescribeRouteRequest)

Describes an existing route.

Public Method DescribeRouteAsync(DescribeRouteRequest, CancellationToken)

Describes an existing route.

Public Method DescribeVirtualNode(DescribeVirtualNodeRequest)

Describes an existing virtual node.

Public Method DescribeVirtualNodeAsync(DescribeVirtualNodeRequest, CancellationToken)

Describes an existing virtual node.

Public Method DescribeVirtualRouter(DescribeVirtualRouterRequest)

Describes an existing virtual router.

Public Method DescribeVirtualRouterAsync(DescribeVirtualRouterRequest, CancellationToken)

Describes an existing virtual router.

Public Method DescribeVirtualService(DescribeVirtualServiceRequest)

Describes an existing virtual service.

Public Method DescribeVirtualServiceAsync(DescribeVirtualServiceRequest, CancellationToken)

Describes an existing virtual service.

Public Method ListMeshes(ListMeshesRequest)

Returns a list of existing service meshes.

Public Method ListMeshesAsync(ListMeshesRequest, CancellationToken)

Returns a list of existing service meshes.

Public Method ListRoutes(ListRoutesRequest)

Returns a list of existing routes in a service mesh.

Public Method ListRoutesAsync(ListRoutesRequest, CancellationToken)

Returns a list of existing routes in a service mesh.

Public Method ListTagsForResource(ListTagsForResourceRequest)

List the tags for an App Mesh resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

List the tags for an App Mesh resource.

Public Method ListVirtualNodes(ListVirtualNodesRequest)

Returns a list of existing virtual nodes.

Public Method ListVirtualNodesAsync(ListVirtualNodesRequest, CancellationToken)

Returns a list of existing virtual nodes.

Public Method ListVirtualRouters(ListVirtualRoutersRequest)

Returns a list of existing virtual routers in a service mesh.

Public Method ListVirtualRoutersAsync(ListVirtualRoutersRequest, CancellationToken)

Returns a list of existing virtual routers in a service mesh.

Public Method ListVirtualServices(ListVirtualServicesRequest)

Returns a list of existing virtual services in a service mesh.

Public Method ListVirtualServicesAsync(ListVirtualServicesRequest, CancellationToken)

Returns a list of existing virtual services in a service mesh.

Public Method TagResource(TagResourceRequest)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Public Method UntagResource(UntagResourceRequest)

Deletes specified tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Deletes specified tags from a resource.

Public Method UpdateMesh(UpdateMeshRequest)

Updates an existing service mesh.

Public Method UpdateMeshAsync(UpdateMeshRequest, CancellationToken)

Updates an existing service mesh.

Public Method UpdateRoute(UpdateRouteRequest)

Updates an existing route for a specified service mesh and virtual router.

Public Method UpdateRouteAsync(UpdateRouteRequest, CancellationToken)

Updates an existing route for a specified service mesh and virtual router.

Public Method UpdateVirtualNode(UpdateVirtualNodeRequest)

Updates an existing virtual node in a specified service mesh.

Public Method UpdateVirtualNodeAsync(UpdateVirtualNodeRequest, CancellationToken)

Updates an existing virtual node in a specified service mesh.

Public Method UpdateVirtualRouter(UpdateVirtualRouterRequest)

Updates an existing virtual router in a specified service mesh.

Public Method UpdateVirtualRouterAsync(UpdateVirtualRouterRequest, CancellationToken)

Updates an existing virtual router in a specified service mesh.

Public Method UpdateVirtualService(UpdateVirtualServiceRequest)

Updates an existing virtual service in a specified service mesh.

Public Method UpdateVirtualServiceAsync(UpdateVirtualServiceRequest, CancellationToken)

Updates an existing virtual service in a specified service mesh.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms