Expand description
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.
If you’re using the service, you’re probably looking for AppMeshClient and AppMesh.
Structs§
- Access
Log An object that represents the access logging information for a virtual node.
- AppMesh
Client - A client for the AWS App Mesh API.
- AwsCloud
MapInstance Attribute An object that represents the Cloud Map attribute information for your virtual node.
AWS Cloud Map is not available in the eu-south-1 Region.
- AwsCloud
MapService Discovery An object that represents the Cloud Map service discovery information for your virtual node.
Cloud Map is not available in the eu-south-1 Region.
- Backend
An object that represents the backends that a virtual node is expected to send outbound traffic to.
- Backend
Defaults An object that represents the default properties for a backend.
- Client
Policy An object that represents a client policy.
- Client
Policy Tls A reference to an object that represents a Transport Layer Security (TLS) client policy.
- Client
TlsCertificate An object that represents the client's certificate.
- Create
Gateway Route Input - Create
Gateway Route Output - Create
Mesh Input - Create
Mesh Output - Create
Route Input - Create
Route Output - Create
Virtual Gateway Input - Create
Virtual Gateway Output - Create
Virtual Node Input - Create
Virtual Node Output - Create
Virtual Router Input - Create
Virtual Router Output - Create
Virtual Service Input - Create
Virtual Service Output - Delete
Gateway Route Input - Delete
Gateway Route Output - Delete
Mesh Input - Delete
Mesh Output - Delete
Route Input - Delete
Route Output - Delete
Virtual Gateway Input - Delete
Virtual Gateway Output - Delete
Virtual Node Input Deletes a virtual node input.
- Delete
Virtual Node Output - Delete
Virtual Router Input - Delete
Virtual Router Output - Delete
Virtual Service Input - Delete
Virtual Service Output - Describe
Gateway Route Input - Describe
Gateway Route Output - Describe
Mesh Input - Describe
Mesh Output - Describe
Route Input - Describe
Route Output - Describe
Virtual Gateway Input - Describe
Virtual Gateway Output - Describe
Virtual Node Input - Describe
Virtual Node Output - Describe
Virtual Router Input - Describe
Virtual Router Output - Describe
Virtual Service Input - Describe
Virtual Service Output - DnsService
Discovery An object that represents the DNS service discovery information for your virtual node.
- Duration
An object that represents a duration of time.
- Egress
Filter An object that represents the egress filter rules for a service mesh.
- File
Access Log An object that represents an access log file.
- Gateway
Route Data An object that represents a gateway route returned by a describe operation.
- Gateway
Route Hostname Match An object representing the gateway route host name to match.
- Gateway
Route Hostname Rewrite An object representing the gateway route host name to rewrite.
- Gateway
Route Ref An object that represents a gateway route returned by a list operation.
- Gateway
Route Spec An object that represents a gateway route specification. Specify one gateway route type.
- Gateway
Route Status An object that represents the current status of a gateway route.
- Gateway
Route Target An object that represents a gateway route target.
- Gateway
Route Virtual Service An object that represents the virtual service that traffic is routed to.
- Grpc
Gateway Route An object that represents a gRPC gateway route.
- Grpc
Gateway Route Action An object that represents the action to take if a match is determined.
- Grpc
Gateway Route Match An object that represents the criteria for determining a request match.
- Grpc
Gateway Route Metadata An object representing the metadata of the gateway route.
- Grpc
Gateway Route Rewrite An object that represents the gateway route to rewrite.
- Grpc
Metadata Match Method An object representing the method header to be matched.
- Grpc
Retry Policy An object that represents a retry policy. Specify at least one value for at least one of the types of
RetryEvents
, a value formaxRetries
, and a value forperRetryTimeout
. Bothserver-error
andgateway-error
underhttpRetryEvents
include the Envoyreset
policy. For more information on thereset
policy, see the Envoy documentation.- Grpc
Route An object that represents a gRPC route type.
- Grpc
Route Action An object that represents the action to take if a match is determined.
- Grpc
Route Match An object that represents the criteria for determining a request match.
- Grpc
Route Metadata An object that represents the match metadata for the route.
- Grpc
Route Metadata Match Method An object that represents the match method. Specify one of the match values.
- Grpc
Timeout An object that represents types of timeouts.
- Header
Match Method An object that represents the method and value to match with the header value sent in a request. Specify one match method.
- Health
Check Policy An object that represents the health check policy for a virtual node's listener.
- Http
Gateway Route An object that represents an HTTP gateway route.
- Http
Gateway Route Action An object that represents the action to take if a match is determined.
- Http
Gateway Route Header An object that represents the HTTP header in the gateway route.
- Http
Gateway Route Match An object that represents the criteria for determining a request match.
- Http
Gateway Route Path Rewrite An object that represents the path to rewrite.
- Http
Gateway Route Prefix Rewrite An object representing the beginning characters of the route to rewrite.
- Http
Gateway Route Rewrite An object representing the gateway route to rewrite.
- Http
Path Match An object representing the path to match in the request.
- Http
Query Parameter An object that represents the query parameter in the request.
- Http
Retry Policy An object that represents a retry policy. Specify at least one value for at least one of the types of
RetryEvents
, a value formaxRetries
, and a value forperRetryTimeout
. Bothserver-error
andgateway-error
underhttpRetryEvents
include the Envoyreset
policy. For more information on thereset
policy, see the Envoy documentation.- Http
Route An object that represents an HTTP or HTTP/2 route type.
- Http
Route Action An object that represents the action to take if a match is determined.
- Http
Route Header An object that represents the HTTP header in the request.
- Http
Route Match An object that represents the requirements for a route to match HTTP requests for a virtual router.
- Http
Timeout An object that represents types of timeouts.
- List
Gateway Routes Input - List
Gateway Routes Output - List
Meshes Input - List
Meshes Output - List
Routes Input - List
Routes Output - List
Tags ForResource Input - List
Tags ForResource Output - List
Virtual Gateways Input - List
Virtual Gateways Output - List
Virtual Nodes Input - List
Virtual Nodes Output - List
Virtual Routers Input - List
Virtual Routers Output - List
Virtual Services Input - List
Virtual Services Output - Listener
An object that represents a listener for a virtual node.
- Listener
Timeout An object that represents timeouts for different protocols.
- Listener
Tls An object that represents the Transport Layer Security (TLS) properties for a listener.
- Listener
TlsAcm Certificate An object that represents an AWS Certicate Manager (ACM) certificate.
- Listener
TlsCertificate An object that represents a listener's Transport Layer Security (TLS) certificate.
- Listener
TlsFile Certificate An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
- Listener
TlsSds Certificate An object that represents the listener's Secret Discovery Service certificate. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
- Listener
TlsValidation Context An object that represents a listener's Transport Layer Security (TLS) validation context.
- Listener
TlsValidation Context Trust An object that represents a listener's Transport Layer Security (TLS) validation context trust.
- Logging
An object that represents the logging information for a virtual node.
- Match
Range An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
- Mesh
Data An object that represents a service mesh returned by a describe operation.
- MeshRef
An object that represents a service mesh returned by a list operation.
- Mesh
Spec An object that represents the specification of a service mesh.
- Mesh
Status An object that represents the status of a service mesh.
- Outlier
Detection An object that represents the outlier detection for a virtual node's listener.
- Port
Mapping An object that represents a port mapping.
- Query
Parameter Match An object representing the query parameter to match.
- Resource
Metadata An object that represents metadata for a resource.
- Route
Data An object that represents a route returned by a describe operation.
- Route
Ref An object that represents a route returned by a list operation.
- Route
Spec An object that represents a route specification. Specify one route type.
- Route
Status An object that represents the current status of a route.
- Service
Discovery An object that represents the service discovery information for a virtual node.
- Subject
Alternative Name Matchers An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
- Subject
Alternative Names An object that represents the subject alternative names secured by the certificate.
- TagRef
Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TagResource
Input - TagResource
Output - TcpRoute
An object that represents a TCP route type.
- TcpRoute
Action An object that represents the action to take if a match is determined.
- TcpTimeout
An object that represents types of timeouts.
- TlsValidation
Context An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.
- TlsValidation
Context AcmTrust An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
- TlsValidation
Context File Trust An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
- TlsValidation
Context SdsTrust An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
- TlsValidation
Context Trust An object that represents a Transport Layer Security (TLS) validation context trust.
- Untag
Resource Input - Untag
Resource Output - Update
Gateway Route Input - Update
Gateway Route Output - Update
Mesh Input - Update
Mesh Output - Update
Route Input - Update
Route Output - Update
Virtual Gateway Input - Update
Virtual Gateway Output - Update
Virtual Node Input - Update
Virtual Node Output - Update
Virtual Router Input - Update
Virtual Router Output - Update
Virtual Service Input - Update
Virtual Service Output - Virtual
Gateway Access Log The access log configuration for a virtual gateway.
- Virtual
Gateway Backend Defaults An object that represents the default properties for a backend.
- Virtual
Gateway Client Policy An object that represents a client policy.
- Virtual
Gateway Client Policy Tls An object that represents a Transport Layer Security (TLS) client policy.
- Virtual
Gateway Client TlsCertificate An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.
- Virtual
Gateway Connection Pool An object that represents the type of virtual gateway connection pool.
Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.
If not present the default value for
maxPendingRequests
is2147483647
.- Virtual
Gateway Data An object that represents a virtual gateway returned by a describe operation.
- Virtual
Gateway File Access Log An object that represents an access log file.
- Virtual
Gateway Grpc Connection Pool An object that represents a type of connection pool.
- Virtual
Gateway Health Check Policy An object that represents the health check policy for a virtual gateway's listener.
- Virtual
Gateway Http2 Connection Pool An object that represents a type of connection pool.
- Virtual
Gateway Http Connection Pool An object that represents a type of connection pool.
- Virtual
Gateway Listener An object that represents a listener for a virtual gateway.
- Virtual
Gateway Listener Tls An object that represents the Transport Layer Security (TLS) properties for a listener.
- Virtual
Gateway Listener TlsAcm Certificate An object that represents an Certificate Manager certificate.
- Virtual
Gateway Listener TlsCertificate An object that represents a listener's Transport Layer Security (TLS) certificate.
- Virtual
Gateway Listener TlsFile Certificate An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
- Virtual
Gateway Listener TlsSds Certificate An object that represents the virtual gateway's listener's Secret Discovery Service certificate.The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App MeshTLS documentation for more info.
- Virtual
Gateway Listener TlsValidation Context An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
- Virtual
Gateway Listener TlsValidation Context Trust An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.
- Virtual
Gateway Logging An object that represents logging information.
- Virtual
Gateway Port Mapping An object that represents a port mapping.
- Virtual
Gateway Ref An object that represents a virtual gateway returned by a list operation.
- Virtual
Gateway Spec An object that represents the specification of a service mesh resource.
- Virtual
Gateway Status An object that represents the status of the mesh resource.
- Virtual
Gateway TlsValidation Context An object that represents a Transport Layer Security (TLS) validation context.
- Virtual
Gateway TlsValidation Context AcmTrust An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
- Virtual
Gateway TlsValidation Context File Trust An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
- Virtual
Gateway TlsValidation Context SdsTrust An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
- Virtual
Gateway TlsValidation Context Trust An object that represents a Transport Layer Security (TLS) validation context trust.
- Virtual
Node Connection Pool An object that represents the type of virtual node connection pool.
Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.
If not present the default value for
maxPendingRequests
is2147483647
.- Virtual
Node Data An object that represents a virtual node returned by a describe operation.
- Virtual
Node Grpc Connection Pool An object that represents a type of connection pool.
- Virtual
Node Http2 Connection Pool An object that represents a type of connection pool.
- Virtual
Node Http Connection Pool An object that represents a type of connection pool.
- Virtual
Node Ref An object that represents a virtual node returned by a list operation.
- Virtual
Node Service Provider An object that represents a virtual node service provider.
- Virtual
Node Spec An object that represents the specification of a virtual node.
- Virtual
Node Status An object that represents the current status of the virtual node.
- Virtual
Node TcpConnection Pool An object that represents a type of connection pool.
- Virtual
Router Data An object that represents a virtual router returned by a describe operation.
- Virtual
Router Listener An object that represents a virtual router listener.
- Virtual
Router Ref An object that represents a virtual router returned by a list operation.
- Virtual
Router Service Provider An object that represents a virtual node service provider.
- Virtual
Router Spec An object that represents the specification of a virtual router.
- Virtual
Router Status An object that represents the status of a virtual router.
- Virtual
Service Backend An object that represents a virtual service backend for a virtual node.
- Virtual
Service Data An object that represents a virtual service returned by a describe operation.
- Virtual
Service Provider An object that represents the provider for a virtual service.
- Virtual
Service Ref An object that represents a virtual service returned by a list operation.
- Virtual
Service Spec An object that represents the specification of a virtual service.
- Virtual
Service Status An object that represents the status of a virtual service.
- Weighted
Target An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
Enums§
- Create
Gateway Route Error - Errors returned by CreateGatewayRoute
- Create
Mesh Error - Errors returned by CreateMesh
- Create
Route Error - Errors returned by CreateRoute
- Create
Virtual Gateway Error - Errors returned by CreateVirtualGateway
- Create
Virtual Node Error - Errors returned by CreateVirtualNode
- Create
Virtual Router Error - Errors returned by CreateVirtualRouter
- Create
Virtual Service Error - Errors returned by CreateVirtualService
- Delete
Gateway Route Error - Errors returned by DeleteGatewayRoute
- Delete
Mesh Error - Errors returned by DeleteMesh
- Delete
Route Error - Errors returned by DeleteRoute
- Delete
Virtual Gateway Error - Errors returned by DeleteVirtualGateway
- Delete
Virtual Node Error - Errors returned by DeleteVirtualNode
- Delete
Virtual Router Error - Errors returned by DeleteVirtualRouter
- Delete
Virtual Service Error - Errors returned by DeleteVirtualService
- Describe
Gateway Route Error - Errors returned by DescribeGatewayRoute
- Describe
Mesh Error - Errors returned by DescribeMesh
- Describe
Route Error - Errors returned by DescribeRoute
- Describe
Virtual Gateway Error - Errors returned by DescribeVirtualGateway
- Describe
Virtual Node Error - Errors returned by DescribeVirtualNode
- Describe
Virtual Router Error - Errors returned by DescribeVirtualRouter
- Describe
Virtual Service Error - Errors returned by DescribeVirtualService
- List
Gateway Routes Error - Errors returned by ListGatewayRoutes
- List
Meshes Error - Errors returned by ListMeshes
- List
Routes Error - Errors returned by ListRoutes
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Virtual Gateways Error - Errors returned by ListVirtualGateways
- List
Virtual Nodes Error - Errors returned by ListVirtualNodes
- List
Virtual Routers Error - Errors returned by ListVirtualRouters
- List
Virtual Services Error - Errors returned by ListVirtualServices
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Gateway Route Error - Errors returned by UpdateGatewayRoute
- Update
Mesh Error - Errors returned by UpdateMesh
- Update
Route Error - Errors returned by UpdateRoute
- Update
Virtual Gateway Error - Errors returned by UpdateVirtualGateway
- Update
Virtual Node Error - Errors returned by UpdateVirtualNode
- Update
Virtual Router Error - Errors returned by UpdateVirtualRouter
- Update
Virtual Service Error - Errors returned by UpdateVirtualService
Traits§
- AppMesh
- Trait representing the capabilities of the AWS App Mesh API. AWS App Mesh clients implement this trait.