- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
AppMeshClient
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 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.
Installation
npm install @aws-sdk/client-app-mesh
yarn add @aws-sdk/client-app-mesh
pnpm add @aws-sdk/client-app-mesh
AppMeshClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateGatewayRouteCommand | 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 . |
CreateMeshCommand | 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 . |
CreateRouteCommand | 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 . |
CreateVirtualGatewayCommand | 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 . |
CreateVirtualNodeCommand | 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 The response metadata for your new virtual node contains the By default, App Mesh uses the name of the resource you specified in For more information about virtual nodes, see Virtual nodes . You must be using |
CreateVirtualRouterCommand | Creates a virtual router within a service mesh. Specify a For more information about virtual routers, see Virtual routers . |
CreateVirtualServiceCommand | 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 For more information about virtual services, see Virtual services . |
DeleteGatewayRouteCommand | Deletes an existing gateway route. |
DeleteMeshCommand | 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. |
DeleteRouteCommand | Deletes an existing route. |
DeleteVirtualGatewayCommand | Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it. |
DeleteVirtualNodeCommand | 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. |
DeleteVirtualRouterCommand | Deletes an existing virtual router. You must delete any routes associated with the virtual router before you can delete the router itself. |
DeleteVirtualServiceCommand | Deletes an existing virtual service. |
DescribeGatewayRouteCommand | Describes an existing gateway route. |
DescribeMeshCommand | Describes an existing service mesh. |
DescribeRouteCommand | Describes an existing route. |
DescribeVirtualGatewayCommand | Describes an existing virtual gateway. |
DescribeVirtualNodeCommand | Describes an existing virtual node. |
DescribeVirtualRouterCommand | Describes an existing virtual router. |
DescribeVirtualServiceCommand | Describes an existing virtual service. |
ListGatewayRoutesCommand | Returns a list of existing gateway routes that are associated to a virtual gateway. |
ListMeshesCommand | Returns a list of existing service meshes. |
ListRoutesCommand | Returns a list of existing routes in a service mesh. |
ListTagsForResourceCommand | List the tags for an App Mesh resource. |
ListVirtualGatewaysCommand | Returns a list of existing virtual gateways in a service mesh. |
ListVirtualNodesCommand | Returns a list of existing virtual nodes. |
ListVirtualRoutersCommand | Returns a list of existing virtual routers in a service mesh. |
ListVirtualServicesCommand | Returns a list of existing virtual services in a service mesh. |
TagResourceCommand | Associates the specified tags to a resource with the specified |
UntagResourceCommand | Deletes specified tags from a resource. |
UpdateGatewayRouteCommand | Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh. |
UpdateMeshCommand | Updates an existing service mesh. |
UpdateRouteCommand | Updates an existing route for a specified service mesh and virtual router. |
UpdateVirtualGatewayCommand | Updates an existing virtual gateway in a specified service mesh. |
UpdateVirtualNodeCommand | Updates an existing virtual node in a specified service mesh. |
UpdateVirtualRouterCommand | Updates an existing virtual router in a specified service mesh. |
UpdateVirtualServiceCommand | Updates an existing virtual service in a specified service mesh. |
AppMeshClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: AppMeshClientConfig