Interface | Description |
---|---|
AccessLogConfig |
All Properties for Envoy Access logs for mesh endpoints.
|
BackendConfig |
Properties for a backend.
|
BackendDefaults |
Represents the properties needed to define backend defaults.
|
CfnGatewayRoute.GatewayRouteHostnameMatchProperty |
An object representing the gateway route host name to match.
|
CfnGatewayRoute.GatewayRouteHostnameRewriteProperty |
An object representing the gateway route host name to rewrite.
|
CfnGatewayRoute.GatewayRouteMetadataMatchProperty |
An object representing the method header to be matched.
|
CfnGatewayRoute.GatewayRouteRangeMatchProperty |
An object that represents the range of values to match on.
|
CfnGatewayRoute.GatewayRouteSpecProperty |
An object that represents a gateway route specification.
|
CfnGatewayRoute.GatewayRouteTargetProperty |
An object that represents a gateway route target.
|
CfnGatewayRoute.GatewayRouteVirtualServiceProperty |
An object that represents the virtual service that traffic is routed to.
|
CfnGatewayRoute.GrpcGatewayRouteActionProperty |
An object that represents the action to take if a match is determined.
|
CfnGatewayRoute.GrpcGatewayRouteMatchProperty |
An object that represents the criteria for determining a request match.
|
CfnGatewayRoute.GrpcGatewayRouteMetadataProperty |
An object representing the metadata of the gateway route.
|
CfnGatewayRoute.GrpcGatewayRouteProperty |
An object that represents a gRPC gateway route.
|
CfnGatewayRoute.GrpcGatewayRouteRewriteProperty |
An object that represents the gateway route to rewrite.
|
CfnGatewayRoute.HttpGatewayRouteActionProperty |
An object that represents the action to take if a match is determined.
|
CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty |
An object that represents the method and value to match with the header value sent in a request.
|
CfnGatewayRoute.HttpGatewayRouteHeaderProperty |
An object that represents the HTTP header in the gateway route.
|
CfnGatewayRoute.HttpGatewayRouteMatchProperty |
An object that represents the criteria for determining a request match.
|
CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty |
An object that represents the path to rewrite.
|
CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty |
An object representing the beginning characters of the route to rewrite.
|
CfnGatewayRoute.HttpGatewayRouteProperty |
An object that represents an HTTP gateway route.
|
CfnGatewayRoute.HttpGatewayRouteRewriteProperty |
An object representing the gateway route to rewrite.
|
CfnGatewayRoute.HttpPathMatchProperty |
An object representing the path to match in the request.
|
CfnGatewayRoute.HttpQueryParameterMatchProperty |
An object representing the query parameter to match.
|
CfnGatewayRoute.QueryParameterProperty |
An object that represents the query parameter in the request.
|
CfnGatewayRouteProps |
Properties for defining a `CfnGatewayRoute`.
|
CfnMesh.EgressFilterProperty |
An object that represents the egress filter rules for a service mesh.
|
CfnMesh.MeshServiceDiscoveryProperty |
An object that represents the service discovery information for a service mesh.
|
CfnMesh.MeshSpecProperty |
An object that represents the specification of a service mesh.
|
CfnMeshProps |
Properties for defining a `CfnMesh`.
|
CfnRoute.DurationProperty |
An object that represents a duration of time.
|
CfnRoute.GrpcRetryPolicyProperty |
An object that represents a retry policy.
|
CfnRoute.GrpcRouteActionProperty |
An object that represents the action to take if a match is determined.
|
CfnRoute.GrpcRouteMatchProperty |
An object that represents the criteria for determining a request match.
|
CfnRoute.GrpcRouteMetadataMatchMethodProperty |
An object that represents the match method.
|
CfnRoute.GrpcRouteMetadataProperty |
An object that represents the match metadata for the route.
|
CfnRoute.GrpcRouteProperty |
An object that represents a gRPC route type.
|
CfnRoute.GrpcTimeoutProperty |
An object that represents types of timeouts.
|
CfnRoute.HeaderMatchMethodProperty |
An object that represents the method and value to match with the header value sent in a request.
|
CfnRoute.HttpPathMatchProperty |
An object representing the path to match in the request.
|
CfnRoute.HttpQueryParameterMatchProperty |
An object representing the query parameter to match.
|
CfnRoute.HttpRetryPolicyProperty |
An object that represents a retry policy.
|
CfnRoute.HttpRouteActionProperty |
An object that represents the action to take if a match is determined.
|
CfnRoute.HttpRouteHeaderProperty |
An object that represents the HTTP header in the request.
|
CfnRoute.HttpRouteMatchProperty |
An object that represents the requirements for a route to match HTTP requests for a virtual router.
|
CfnRoute.HttpRouteProperty |
An object that represents an HTTP or HTTP/2 route type.
|
CfnRoute.HttpTimeoutProperty |
An object that represents types of timeouts.
|
CfnRoute.MatchRangeProperty |
An object that represents the range of values to match on.
|
CfnRoute.QueryParameterProperty |
An object that represents the query parameter in the request.
|
CfnRoute.RouteSpecProperty |
An object that represents a route specification.
|
CfnRoute.TcpRouteActionProperty |
An object that represents the action to take if a match is determined.
|
CfnRoute.TcpRouteMatchProperty |
An object representing the TCP route to match.
|
CfnRoute.TcpRouteProperty |
An object that represents a TCP route type.
|
CfnRoute.TcpTimeoutProperty |
An object that represents types of timeouts.
|
CfnRoute.WeightedTargetProperty |
An object that represents a target and its relative weight.
|
CfnRouteProps |
Properties for defining a `CfnRoute`.
|
CfnVirtualGateway.JsonFormatRefProperty |
An object that represents the key value pairs for the JSON.
|
CfnVirtualGateway.LoggingFormatProperty |
An object that represents the format for the logs.
|
CfnVirtualGateway.SubjectAlternativeNameMatchersProperty |
An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
|
CfnVirtualGateway.SubjectAlternativeNamesProperty |
An object that represents the subject alternative names secured by the certificate.
|
CfnVirtualGateway.VirtualGatewayAccessLogProperty |
The access log configuration for a virtual gateway.
|
CfnVirtualGateway.VirtualGatewayBackendDefaultsProperty |
An object that represents the default properties for a backend.
|
CfnVirtualGateway.VirtualGatewayClientPolicyProperty |
An object that represents a client policy.
|
CfnVirtualGateway.VirtualGatewayClientPolicyTlsProperty |
An object that represents a Transport Layer Security (TLS) client policy.
|
CfnVirtualGateway.VirtualGatewayClientTlsCertificateProperty |
An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.
|
CfnVirtualGateway.VirtualGatewayConnectionPoolProperty |
An object that represents the type of virtual gateway connection pool.
|
CfnVirtualGateway.VirtualGatewayFileAccessLogProperty |
An object that represents an access log file.
|
CfnVirtualGateway.VirtualGatewayGrpcConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty |
An object that represents the health check policy for a virtual gateway's listener.
|
CfnVirtualGateway.VirtualGatewayHttp2ConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualGateway.VirtualGatewayHttpConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualGateway.VirtualGatewayListenerProperty |
An object that represents a listener for a virtual gateway.
|
CfnVirtualGateway.VirtualGatewayListenerTlsAcmCertificateProperty |
An object that represents an AWS Certificate Manager certificate.
|
CfnVirtualGateway.VirtualGatewayListenerTlsCertificateProperty |
An object that represents a listener's Transport Layer Security (TLS) certificate.
|
CfnVirtualGateway.VirtualGatewayListenerTlsFileCertificateProperty |
An object that represents a local file certificate.
|
CfnVirtualGateway.VirtualGatewayListenerTlsProperty |
An object that represents the Transport Layer Security (TLS) properties for a listener.
|
CfnVirtualGateway.VirtualGatewayListenerTlsSdsCertificateProperty |
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.
|
CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextProperty |
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
|
CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextTrustProperty |
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.
|
CfnVirtualGateway.VirtualGatewayLoggingProperty |
An object that represents logging information.
|
CfnVirtualGateway.VirtualGatewayPortMappingProperty |
An object that represents a port mapping.
|
CfnVirtualGateway.VirtualGatewaySpecProperty |
An object that represents the specification of a service mesh resource.
|
CfnVirtualGateway.VirtualGatewayTlsValidationContextAcmTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate.
|
CfnVirtualGateway.VirtualGatewayTlsValidationContextFileTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
|
CfnVirtualGateway.VirtualGatewayTlsValidationContextProperty |
An object that represents a Transport Layer Security (TLS) validation context.
|
CfnVirtualGateway.VirtualGatewayTlsValidationContextSdsTrustProperty |
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
|
CfnVirtualGateway.VirtualGatewayTlsValidationContextTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust.
|
CfnVirtualGatewayProps |
Properties for defining a `CfnVirtualGateway`.
|
CfnVirtualNode.AccessLogProperty |
An object that represents the access logging information for a virtual node.
|
CfnVirtualNode.AwsCloudMapInstanceAttributeProperty |
An object that represents the AWS Cloud Map attribute information for your virtual node.
|
CfnVirtualNode.AwsCloudMapServiceDiscoveryProperty |
An object that represents the AWS Cloud Map service discovery information for your virtual node.
|
CfnVirtualNode.BackendDefaultsProperty |
An object that represents the default properties for a backend.
|
CfnVirtualNode.BackendProperty |
An object that represents the backends that a virtual node is expected to send outbound traffic to.
|
CfnVirtualNode.ClientPolicyProperty |
An object that represents a client policy.
|
CfnVirtualNode.ClientPolicyTlsProperty |
A reference to an object that represents a Transport Layer Security (TLS) client policy.
|
CfnVirtualNode.ClientTlsCertificateProperty |
An object that represents the client's certificate.
|
CfnVirtualNode.DnsServiceDiscoveryProperty |
An object that represents the DNS service discovery information for your virtual node.
|
CfnVirtualNode.DurationProperty |
An object that represents a duration of time.
|
CfnVirtualNode.FileAccessLogProperty |
An object that represents an access log file.
|
CfnVirtualNode.GrpcTimeoutProperty |
An object that represents types of timeouts.
|
CfnVirtualNode.HealthCheckProperty |
An object that represents the health check policy for a virtual node's listener.
|
CfnVirtualNode.HttpTimeoutProperty |
An object that represents types of timeouts.
|
CfnVirtualNode.JsonFormatRefProperty |
An object that represents the key value pairs for the JSON.
|
CfnVirtualNode.ListenerProperty |
An object that represents a listener for a virtual node.
|
CfnVirtualNode.ListenerTimeoutProperty |
An object that represents timeouts for different protocols.
|
CfnVirtualNode.ListenerTlsAcmCertificateProperty |
An object that represents an AWS Certificate Manager certificate.
|
CfnVirtualNode.ListenerTlsCertificateProperty |
An object that represents a listener's Transport Layer Security (TLS) certificate.
|
CfnVirtualNode.ListenerTlsFileCertificateProperty |
An object that represents a local file certificate.
|
CfnVirtualNode.ListenerTlsProperty |
An object that represents the Transport Layer Security (TLS) properties for a listener.
|
CfnVirtualNode.ListenerTlsSdsCertificateProperty |
An object that represents the listener's Secret Discovery Service certificate.
|
CfnVirtualNode.ListenerTlsValidationContextProperty |
An object that represents a listener's Transport Layer Security (TLS) validation context.
|
CfnVirtualNode.ListenerTlsValidationContextTrustProperty |
An object that represents a listener's Transport Layer Security (TLS) validation context trust.
|
CfnVirtualNode.LoggingFormatProperty |
An object that represents the format for the logs.
|
CfnVirtualNode.LoggingProperty |
An object that represents the logging information for a virtual node.
|
CfnVirtualNode.OutlierDetectionProperty |
An object that represents the outlier detection for a virtual node's listener.
|
CfnVirtualNode.PortMappingProperty |
An object representing a virtual node or virtual router listener port mapping.
|
CfnVirtualNode.ServiceDiscoveryProperty |
An object that represents the service discovery information for a virtual node.
|
CfnVirtualNode.SubjectAlternativeNameMatchersProperty |
An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
|
CfnVirtualNode.SubjectAlternativeNamesProperty |
An object that represents the subject alternative names secured by the certificate.
|
CfnVirtualNode.TcpTimeoutProperty |
An object that represents types of timeouts.
|
CfnVirtualNode.TlsValidationContextAcmTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate.
|
CfnVirtualNode.TlsValidationContextFileTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
|
CfnVirtualNode.TlsValidationContextProperty |
An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.
|
CfnVirtualNode.TlsValidationContextSdsTrustProperty |
An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
|
CfnVirtualNode.TlsValidationContextTrustProperty |
An object that represents a Transport Layer Security (TLS) validation context trust.
|
CfnVirtualNode.VirtualNodeConnectionPoolProperty |
An object that represents the type of virtual node connection pool.
|
CfnVirtualNode.VirtualNodeGrpcConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualNode.VirtualNodeHttp2ConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualNode.VirtualNodeHttpConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualNode.VirtualNodeSpecProperty |
An object that represents the specification of a virtual node.
|
CfnVirtualNode.VirtualNodeTcpConnectionPoolProperty |
An object that represents a type of connection pool.
|
CfnVirtualNode.VirtualServiceBackendProperty |
An object that represents a virtual service backend for a virtual node.
|
CfnVirtualNodeProps |
Properties for defining a `CfnVirtualNode`.
|
CfnVirtualRouter.PortMappingProperty |
An object representing a virtual router listener port mapping.
|
CfnVirtualRouter.VirtualRouterListenerProperty |
An object that represents a virtual router listener.
|
CfnVirtualRouter.VirtualRouterSpecProperty |
An object that represents the specification of a virtual router.
|
CfnVirtualRouterProps |
Properties for defining a `CfnVirtualRouter`.
|
CfnVirtualService.VirtualNodeServiceProviderProperty |
An object that represents a virtual node service provider.
|
CfnVirtualService.VirtualRouterServiceProviderProperty |
An object that represents a virtual node service provider.
|
CfnVirtualService.VirtualServiceProviderProperty |
An object that represents the provider for a virtual service.
|
CfnVirtualService.VirtualServiceSpecProperty |
An object that represents the specification of a virtual service.
|
CfnVirtualServiceProps |
Properties for defining a `CfnVirtualService`.
|
CommonGatewayRouteSpecOptions |
Base options for all gateway route specs.
|
GatewayRouteAttributes |
Interface with properties necessary to import a reusable GatewayRoute.
|
GatewayRouteBaseProps |
Basic configuration properties for a GatewayRoute.
|
GatewayRouteHostnameMatchConfig |
Configuration for gateway route host name match.
|
GatewayRouteProps |
Properties to define a new GatewayRoute.
|
GatewayRouteSpecConfig |
All Properties for GatewayRoute Specs.
|
GrpcConnectionPool |
Connection pool properties for gRPC listeners.
|
GrpcGatewayListenerOptions |
Represents the properties needed to define GRPC Listeners for a VirtualGateway.
|
GrpcGatewayRouteMatch |
The criterion for determining a request match for this GatewayRoute.
|
GrpcGatewayRouteSpecOptions |
Properties specific for a gRPC GatewayRoute.
|
GrpcHealthCheckOptions |
Properties used to define GRPC Based healthchecks.
|
GrpcRetryPolicy |
gRPC retry policy.
|
GrpcRouteMatch |
The criterion for determining a request match for this Route.
|
GrpcRouteSpecOptions |
Properties specific for a GRPC Based Routes.
|
GrpcTimeout |
Represents timeouts for GRPC protocols.
|
GrpcVirtualNodeListenerOptions |
Represent the GRPC Node Listener prorperty.
|
HeaderMatchConfig |
Configuration for `HeaderMatch`.
|
HealthCheckBindOptions |
Options used for creating the Health Check object.
|
HealthCheckConfig |
All Properties for Health Checks for mesh endpoints.
|
Http2ConnectionPool |
Connection pool properties for HTTP2 listeners.
|
Http2GatewayListenerOptions |
Represents the properties needed to define HTTP2 Listeners for a VirtualGateway.
|
Http2VirtualNodeListenerOptions |
Represent the HTTP2 Node Listener prorperty.
|
HttpConnectionPool |
Connection pool properties for HTTP listeners.
|
HttpGatewayListenerOptions |
Represents the properties needed to define HTTP Listeners for a VirtualGateway.
|
HttpGatewayRouteMatch |
The criterion for determining a request match for this GatewayRoute.
|
HttpGatewayRoutePathMatchConfig |
The type returned from the `bind()` method in
HttpGatewayRoutePathMatch . |
HttpGatewayRouteSpecOptions |
Properties specific for HTTP Based GatewayRoutes.
|
HttpHealthCheckOptions |
Properties used to define HTTP Based healthchecks.
|
HttpRetryPolicy |
HTTP retry policy.
|
HttpRouteMatch |
The criterion for determining a request match for this Route.
|
HttpRoutePathMatchConfig |
The type returned from the `bind()` method in
HttpRoutePathMatch . |
HttpRouteSpecOptions |
Properties specific for HTTP Based Routes.
|
HttpTimeout |
Represents timeouts for HTTP protocols.
|
HttpVirtualNodeListenerOptions |
Represent the HTTP Node Listener prorperty.
|
IGatewayRoute |
Interface for which all GatewayRoute based classes MUST implement.
|
IGatewayRoute.Jsii$Default |
Internal default implementation for
IGatewayRoute . |
IMesh |
Interface which all Mesh based classes MUST implement.
|
IMesh.Jsii$Default |
Internal default implementation for
IMesh . |
IRoute |
Interface for which all Route based classes MUST implement.
|
IRoute.Jsii$Default |
Internal default implementation for
IRoute . |
IVirtualGateway |
Interface which all Virtual Gateway based classes must implement.
|
IVirtualGateway.Jsii$Default |
Internal default implementation for
IVirtualGateway . |
IVirtualNode |
Interface which all VirtualNode based classes must implement.
|
IVirtualNode.Jsii$Default |
Internal default implementation for
IVirtualNode . |
IVirtualRouter |
Interface which all VirtualRouter based classes MUST implement.
|
IVirtualRouter.Jsii$Default |
Internal default implementation for
IVirtualRouter . |
IVirtualService |
Represents the interface which all VirtualService based classes MUST implement.
|
IVirtualService.Jsii$Default |
Internal default implementation for
IVirtualService . |
ListenerTlsOptions |
Represents TLS properties for listener.
|
MeshProps |
The set of properties used when creating a Mesh.
|
MutualTlsValidation |
Represents the properties needed to define TLS Validation context that is supported for mutual TLS authentication.
|
OutlierDetection |
Represents the outlier detection for a listener.
|
QueryParameterMatchConfig |
Configuration for `QueryParameterMatch`.
|
RouteAttributes |
Interface with properties ncecessary to import a reusable Route.
|
RouteBaseProps |
Base interface properties for all Routes.
|
RouteProps |
Properties to define new Routes.
|
RouteSpecConfig |
All Properties for Route Specs.
|
RouteSpecOptionsBase |
Base options for all route specs.
|
ServiceDiscoveryConfig |
Properties for VirtualNode Service Discovery.
|
SubjectAlternativeNamesMatcherConfig |
All Properties for Subject Alternative Names Matcher for both Client Policy and Listener.
|
TcpConnectionPool |
Connection pool properties for TCP listeners.
|
TcpHealthCheckOptions |
Properties used to define TCP Based healthchecks.
|
TcpRouteSpecOptions |
Properties specific for a TCP Based Routes.
|
TcpTimeout |
Represents timeouts for TCP protocols.
|
TcpVirtualNodeListenerOptions |
Represent the TCP Node Listener prorperty.
|
TlsCertificateConfig |
A wrapper for the tls config returned by
TlsCertificate.bind . |
TlsClientPolicy |
Represents the properties needed to define client policy.
|
TlsValidation |
Represents the properties needed to define TLS Validation context.
|
TlsValidationTrustConfig |
All Properties for TLS Validation Trusts for both Client Policy and Listener.
|
VirtualGatewayAttributes |
Unterface with properties necessary to import a reusable VirtualGateway.
|
VirtualGatewayBaseProps |
Basic configuration properties for a VirtualGateway.
|
VirtualGatewayListenerConfig |
Properties for a VirtualGateway listener.
|
VirtualGatewayProps |
Properties used when creating a new VirtualGateway.
|
VirtualNodeAttributes |
Interface with properties necessary to import a reusable VirtualNode.
|
VirtualNodeBaseProps |
Basic configuration properties for a VirtualNode.
|
VirtualNodeListenerConfig |
Properties for a VirtualNode listener.
|
VirtualNodeProps |
The properties used when creating a new VirtualNode.
|
VirtualRouterAttributes |
Interface with properties ncecessary to import a reusable VirtualRouter.
|
VirtualRouterBaseProps |
Interface with base properties all routers willl inherit.
|
VirtualRouterListenerConfig |
Properties for a VirtualRouter listener.
|
VirtualRouterProps |
The properties used when creating a new VirtualRouter.
|
VirtualServiceAttributes |
Interface with properties ncecessary to import a reusable VirtualService.
|
VirtualServiceBackendOptions |
Represents the properties needed to define a Virtual Service backend.
|
VirtualServiceProps |
The properties applied to the VirtualService being defined.
|
VirtualServiceProviderConfig |
Properties for a VirtualService provider.
|
WeightedTarget |
Properties for the Weighted Targets in the route.
|
Enum | Description |
---|---|
DnsResponseType |
Enum of DNS service discovery response type.
|
GrpcRetryEvent |
gRPC events.
|
HttpRetryEvent |
HTTP events on which to retry.
|
HttpRouteMethod |
Supported values for matching routes based on the HTTP request method.
|
HttpRouteProtocol |
Supported :scheme options for HTTP2.
|
MeshFilterType |
A utility enum defined for the egressFilter type property, the default of DROP_ALL, allows traffic only to other resources inside the mesh, or API calls to amazon resources.
|
Protocol | Deprecated
not for use outside package
|
TcpRetryEvent |
TCP events on which you may retry.
|
TlsMode |
Enum of supported TLS modes.
|
---
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.
App Mesh supports microservice applications that use service discovery naming for their components. To use App Mesh, you must have an existing application running on AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, or Amazon EC2.
For further information on AWS App Mesh, visit the AWS App Mesh Documentation.
App app = new App(); Stack stack = new Stack(app, "stack");
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.
The following example creates the AppMesh
service mesh with the default egress filter of DROP_ALL
. See the AWS CloudFormation EgressFilter
resource for more info on egress filters.
Mesh mesh = Mesh.Builder.create(this, "AppMesh") .meshName("myAwsMesh") .build();
The mesh can instead be created with the ALLOW_ALL
egress filter by providing the egressFilter
property.
Mesh mesh = Mesh.Builder.create(this, "AppMesh") .meshName("myAwsMesh") .egressFilter(MeshFilterType.ALLOW_ALL) .build();
A mesh uses virtual routers as logical units to route requests to virtual nodes.
Virtual routers handle traffic for one or more virtual services within your mesh. After you create a virtual router, you can create and associate routes to your virtual router that direct incoming requests to different virtual nodes.
Mesh mesh; VirtualRouter router = mesh.addVirtualRouter("router", VirtualRouterBaseProps.builder() .listeners(List.of(VirtualRouterListener.http(8080))) .build());
Note that creating the router using the addVirtualRouter()
method places it in the same stack as the mesh
(which might be different from the current stack).
The router can also be created using the VirtualRouter
constructor (passing in the mesh) instead of calling the addVirtualRouter()
method.
This is particularly useful when splitting your resources between many stacks: for example, defining the mesh itself as part of an infrastructure stack, but defining the other resources, such as routers, in the application stack:
Stack infraStack; Stack appStack; Mesh mesh = Mesh.Builder.create(infraStack, "AppMesh") .meshName("myAwsMesh") .egressFilter(MeshFilterType.ALLOW_ALL) .build(); // the VirtualRouter will belong to 'appStack', // even though the Mesh belongs to 'infraStack' VirtualRouter router = VirtualRouter.Builder.create(appStack, "router") .mesh(mesh) // notice that mesh is a required property when creating a router with the 'new' statement .listeners(List.of(VirtualRouterListener.http(8081))) .build();
The same is true for other add*()
methods in the App Mesh construct library.
The VirtualRouterListener
class lets you define protocol-specific listeners.
The http()
, http2()
, grpc()
and tcp()
methods create listeners for the named protocols.
They accept a single parameter that defines the port to on which requests will be matched.
The port parameter defaults to 8080 if omitted.
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 specified as the provider for the virtual service.
We recommend that you use the service discovery name of the real service that you're targeting (such as my-service.default.svc.cluster.local
).
When creating a virtual service:
Adding a virtual router as the provider:
VirtualRouter router; VirtualService.Builder.create(this, "virtual-service") .virtualServiceName("my-service.default.svc.cluster.local") // optional .virtualServiceProvider(VirtualServiceProvider.virtualRouter(router)) .build();
Adding a virtual node as the provider:
VirtualNode node; VirtualService.Builder.create(this, "virtual-service") .virtualServiceName("my-service.default.svc.cluster.local") // optional .virtualServiceProvider(VirtualServiceProvider.virtualNode(node)) .build();
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, accept inbound traffic by specifying a listener. Outbound traffic that your virtual node expects to send should be specified as a back end.
The response metadata for your new virtual node contains the Amazon Resource Name (ARN) that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name) as the APPMESH_VIRTUAL_NODE_NAME
environment variable for your task group's Envoy proxy container in your task definition or pod spec. For example, the value could be mesh/default/virtualNode/simpleapp
. This is then mapped to the node.id
and node.cluster
Envoy parameters.
Note If you require your Envoy stats or tracing to use a different name, you can override the
node.cluster
value that is set byAPPMESH_VIRTUAL_NODE_NAME
with theAPPMESH_VIRTUAL_NODE_CLUSTER
environment variable.
Mesh mesh; Vpc vpc = new Vpc(this, "vpc"); PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace") .vpc(vpc) .name("domain.local") .build(); Service service = namespace.createService("Svc"); VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder() .serviceDiscovery(ServiceDiscovery.cloudMap(service)) .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder() .port(8081) .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder() .healthyThreshold(3) .interval(Duration.seconds(5)) // minimum .path("/health-check-path") .timeout(Duration.seconds(2)) // minimum .unhealthyThreshold(2) .build())) .build()))) .accessLog(AccessLog.fromFilePath("/dev/stdout")) .build());
Create a VirtualNode
with the constructor and add tags.
Mesh mesh; Service service; VirtualNode node = VirtualNode.Builder.create(this, "node") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.cloudMap(service)) .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder() .port(8080) .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder() .healthyThreshold(3) .interval(Duration.seconds(5)) .path("/ping") .timeout(Duration.seconds(2)) .unhealthyThreshold(2) .build())) .timeout(HttpTimeout.builder() .idle(Duration.seconds(5)) .build()) .build()))) .backendDefaults(BackendDefaults.builder() .tlsClientPolicy(TlsClientPolicy.builder() .validation(TlsValidation.builder() .trust(TlsValidationTrust.file("/keys/local_cert_chain.pem")) .build()) .build()) .build()) .accessLog(AccessLog.fromFilePath("/dev/stdout")) .build(); Tags.of(node).add("Environment", "Dev");
Create a VirtualNode
with the constructor and add backend virtual service.
Mesh mesh; VirtualRouter router; Service service; VirtualNode node = VirtualNode.Builder.create(this, "node") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.cloudMap(service)) .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder() .port(8080) .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder() .healthyThreshold(3) .interval(Duration.seconds(5)) .path("/ping") .timeout(Duration.seconds(2)) .unhealthyThreshold(2) .build())) .timeout(HttpTimeout.builder() .idle(Duration.seconds(5)) .build()) .build()))) .accessLog(AccessLog.fromFilePath("/dev/stdout")) .build(); VirtualService virtualService = VirtualService.Builder.create(this, "service-1") .virtualServiceProvider(VirtualServiceProvider.virtualRouter(router)) .virtualServiceName("service1.domain.local") .build(); node.addBackend(Backend.virtualService(virtualService));
The listeners
property can be left blank and added later with the node.addListener()
method. The serviceDiscovery
property must be specified when specifying a listener.
The backends
property can be added with node.addBackend()
. In the example, we define a virtual service and add it to the virtual node to allow egress traffic to other nodes.
The backendDefaults
property is added to the node while creating the virtual node. These are the virtual node's default settings for all backends.
The VirtualNode.addBackend()
method is especially useful if you want to create a circular traffic flow by having a Virtual Service as a backend whose provider is that same Virtual Node:
Mesh mesh; VirtualNode node = VirtualNode.Builder.create(this, "node") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.dns("node")) .build(); VirtualService virtualService = VirtualService.Builder.create(this, "service-1") .virtualServiceProvider(VirtualServiceProvider.virtualNode(node)) .virtualServiceName("service1.domain.local") .build(); node.addBackend(Backend.virtualService(virtualService));
The tls
property specifies TLS configuration when creating a listener for a virtual node or a virtual gateway.
Provide the TLS certificate to the proxy in one of the following ways:
certificateChain
path file and a privateKey
file path).secretName
).
// A Virtual Node with listener TLS from an ACM provided certificate Certificate cert; Mesh mesh; VirtualNode node = VirtualNode.Builder.create(this, "node") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.dns("node")) .listeners(List.of(VirtualNodeListener.grpc(GrpcVirtualNodeListenerOptions.builder() .port(80) .tls(ListenerTlsOptions.builder() .mode(TlsMode.STRICT) .certificate(TlsCertificate.acm(cert)) .build()) .build()))) .build(); // A Virtual Gateway with listener TLS from a customer provided file certificate VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway") .mesh(mesh) .listeners(List.of(VirtualGatewayListener.grpc(GrpcGatewayListenerOptions.builder() .port(8080) .tls(ListenerTlsOptions.builder() .mode(TlsMode.STRICT) .certificate(TlsCertificate.file("path/to/certChain", "path/to/privateKey")) .build()) .build()))) .virtualGatewayName("gateway") .build(); // A Virtual Gateway with listener TLS from a SDS provided certificate VirtualGateway gateway2 = VirtualGateway.Builder.create(this, "gateway2") .mesh(mesh) .listeners(List.of(VirtualGatewayListener.http2(Http2GatewayListenerOptions.builder() .port(8080) .tls(ListenerTlsOptions.builder() .mode(TlsMode.STRICT) .certificate(TlsCertificate.sds("secrete_certificate")) .build()) .build()))) .virtualGatewayName("gateway2") .build();
Mutual TLS authentication is an optional component of TLS that offers two-way peer authentication.
To enable mutual TLS authentication, add the mutualTlsCertificate
property to TLS client policy and/or the mutualTlsValidation
property to your TLS listener.
tls.mutualTlsValidation
and tlsClientPolicy.mutualTlsCertificate
can be sourced from either:
certificateChain
path file and a privateKey
file path).secretName
).
Note Currently, a certificate from AWS Certificate Manager (ACM) cannot be used for mutual TLS authentication.
Mesh mesh; VirtualNode node1 = VirtualNode.Builder.create(this, "node1") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.dns("node")) .listeners(List.of(VirtualNodeListener.grpc(GrpcVirtualNodeListenerOptions.builder() .port(80) .tls(ListenerTlsOptions.builder() .mode(TlsMode.STRICT) .certificate(TlsCertificate.file("path/to/certChain", "path/to/privateKey")) // Validate a file client certificates to enable mutual TLS authentication when a client provides a certificate. .mutualTlsValidation(MutualTlsValidation.builder() .trust(TlsValidationTrust.file("path-to-certificate")) .build()) .build()) .build()))) .build(); String certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012"; VirtualNode node2 = VirtualNode.Builder.create(this, "node2") .mesh(mesh) .serviceDiscovery(ServiceDiscovery.dns("node2")) .backendDefaults(BackendDefaults.builder() .tlsClientPolicy(TlsClientPolicy.builder() .ports(List.of(8080, 8081)) .validation(TlsValidation.builder() .subjectAlternativeNames(SubjectAlternativeNames.matchingExactly("mesh-endpoint.apps.local")) .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn)))) .build()) // Provide a SDS client certificate when a server requests it and enable mutual TLS authentication. .mutualTlsCertificate(TlsCertificate.sds("secret_certificate")) .build()) .build()) .build();
The outlierDetection
property adds outlier detection to a Virtual Node listener. The properties
baseEjectionDuration
, interval
, maxEjectionPercent
, and maxServerErrors
are required.
Mesh mesh; // Cloud Map service discovery is currently required for host ejection by outlier detection Vpc vpc = new Vpc(this, "vpc"); PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace") .vpc(vpc) .name("domain.local") .build(); Service service = namespace.createService("Svc"); VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder() .serviceDiscovery(ServiceDiscovery.cloudMap(service)) .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder() .outlierDetection(OutlierDetection.builder() .baseEjectionDuration(Duration.seconds(10)) .interval(Duration.seconds(30)) .maxEjectionPercent(50) .maxServerErrors(5) .build()) .build()))) .build());
The connectionPool
property can be added to a Virtual Node listener or Virtual Gateway listener to add a request connection pool. Each listener protocol type has its own connection pool properties.
// A Virtual Node with a gRPC listener with a connection pool set Mesh mesh; VirtualNode node = VirtualNode.Builder.create(this, "node") .mesh(mesh) // DNS service discovery can optionally specify the DNS response type as either LOAD_BALANCER or ENDPOINTS. // LOAD_BALANCER means that the DNS resolver returns a loadbalanced set of endpoints, // whereas ENDPOINTS means that the DNS resolver is returning all the endpoints. // By default, the response type is assumed to be LOAD_BALANCER .serviceDiscovery(ServiceDiscovery.dns("node", DnsResponseType.ENDPOINTS)) .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder() .port(80) .connectionPool(HttpConnectionPool.builder() .maxConnections(100) .maxPendingRequests(10) .build()) .build()))) .build(); // A Virtual Gateway with a gRPC listener with a connection pool set VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway") .mesh(mesh) .listeners(List.of(VirtualGatewayListener.grpc(GrpcGatewayListenerOptions.builder() .port(8080) .connectionPool(GrpcConnectionPool.builder() .maxRequests(10) .build()) .build()))) .virtualGatewayName("gateway") .build();
A route matches requests with an associated virtual router and distributes traffic to its associated virtual nodes. The route distributes matching requests to one or more target virtual nodes with relative weighting.
The RouteSpec
class lets you define protocol-specific route specifications.
The tcp()
, http()
, http2()
, and grpc()
methods create a specification for the named protocols.
For HTTP-based routes, the match field can match on path (prefix, exact, or regex), HTTP method, scheme, HTTP headers, and query parameters. By default, HTTP-based routes match all requests.
For gRPC-based routes, the match field can match on service name, method name, and metadata. When specifying the method name, the service name must also be specified.
For example, here's how to add an HTTP route that matches based on a prefix of the URL path:
VirtualRouter router; VirtualNode node; router.addRoute("route-http", RouteBaseProps.builder() .routeSpec(RouteSpec.http(HttpRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder() .virtualNode(node) .build())) .match(HttpRouteMatch.builder() // Path that is passed to this method must start with '/'. .path(HttpRoutePathMatch.startsWith("/path-to-app")) .build()) .build())) .build());
Add an HTTP2 route that matches based on exact path, method, scheme, headers, and query parameters:
VirtualRouter router; VirtualNode node; router.addRoute("route-http2", RouteBaseProps.builder() .routeSpec(RouteSpec.http2(HttpRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder() .virtualNode(node) .build())) .match(HttpRouteMatch.builder() .path(HttpRoutePathMatch.exactly("/exact")) .method(HttpRouteMethod.POST) .protocol(HttpRouteProtocol.HTTPS) .headers(List.of(HeaderMatch.valueIs("Content-Type", "application/json"), HeaderMatch.valueIsNot("Content-Type", "application/json"))) .queryParameters(List.of(QueryParameterMatch.valueIs("query-field", "value"))) .build()) .build())) .build());
Add a single route with two targets and split traffic 50/50:
VirtualRouter router; VirtualNode node; router.addRoute("route-http", RouteBaseProps.builder() .routeSpec(RouteSpec.http(HttpRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder() .virtualNode(node) .weight(50) .build(), WeightedTarget.builder() .virtualNode(node) .weight(50) .build())) .match(HttpRouteMatch.builder() .path(HttpRoutePathMatch.startsWith("/path-to-app")) .build()) .build())) .build());
Add an http2 route with retries:
VirtualRouter router; VirtualNode node; router.addRoute("route-http2-retry", RouteBaseProps.builder() .routeSpec(RouteSpec.http2(HttpRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder().virtualNode(node).build())) .retryPolicy(HttpRetryPolicy.builder() // Retry if the connection failed .tcpRetryEvents(List.of(TcpRetryEvent.CONNECTION_ERROR)) // Retry if HTTP responds with a gateway error (502, 503, 504) .httpRetryEvents(List.of(HttpRetryEvent.GATEWAY_ERROR)) // Retry five times .retryAttempts(5) // Use a 1 second timeout per retry .retryTimeout(Duration.seconds(1)) .build()) .build())) .build());
Add a gRPC route with retries:
VirtualRouter router; VirtualNode node; router.addRoute("route-grpc-retry", RouteBaseProps.builder() .routeSpec(RouteSpec.grpc(GrpcRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder().virtualNode(node).build())) .match(GrpcRouteMatch.builder().serviceName("servicename").build()) .retryPolicy(GrpcRetryPolicy.builder() .tcpRetryEvents(List.of(TcpRetryEvent.CONNECTION_ERROR)) .httpRetryEvents(List.of(HttpRetryEvent.GATEWAY_ERROR)) // Retry if gRPC responds that the request was cancelled, a resource // was exhausted, or if the service is unavailable .grpcRetryEvents(List.of(GrpcRetryEvent.CANCELLED, GrpcRetryEvent.RESOURCE_EXHAUSTED, GrpcRetryEvent.UNAVAILABLE)) .retryAttempts(5) .retryTimeout(Duration.seconds(1)) .build()) .build())) .build());
Add an gRPC route that matches based on method name and metadata:
VirtualRouter router; VirtualNode node; router.addRoute("route-grpc-retry", RouteBaseProps.builder() .routeSpec(RouteSpec.grpc(GrpcRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder().virtualNode(node).build())) .match(GrpcRouteMatch.builder() // When method name is specified, service name must be also specified. .methodName("methodname") .serviceName("servicename") .metadata(List.of(HeaderMatch.valueStartsWith("Content-Type", "application/"), HeaderMatch.valueDoesNotStartWith("Content-Type", "text/"))) .build()) .build())) .build());
Add a gRPC route with timeout:
VirtualRouter router; VirtualNode node; router.addRoute("route-http", RouteBaseProps.builder() .routeSpec(RouteSpec.grpc(GrpcRouteSpecOptions.builder() .weightedTargets(List.of(WeightedTarget.builder() .virtualNode(node) .build())) .match(GrpcRouteMatch.builder() .serviceName("my-service.default.svc.cluster.local") .build()) .timeout(GrpcTimeout.builder() .idle(Duration.seconds(2)) .perRequest(Duration.seconds(1)) .build()) .build())) .build());
A virtual gateway allows resources outside your mesh to communicate with resources 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 Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
A virtual gateway is similar to a virtual node in that it has a listener that accepts traffic for a particular port and protocol (HTTP, HTTP2, gRPC). Traffic received by the virtual gateway is directed to other services in your mesh using rules defined in gateway routes which can be added to your virtual gateway.
Create a virtual gateway with the constructor:
Mesh mesh; String certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012"; VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway") .mesh(mesh) .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder() .port(443) .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder() .interval(Duration.seconds(10)) .build())) .build()))) .backendDefaults(BackendDefaults.builder() .tlsClientPolicy(TlsClientPolicy.builder() .ports(List.of(8080, 8081)) .validation(TlsValidation.builder() .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn)))) .build()) .build()) .build()) .accessLog(AccessLog.fromFilePath("/dev/stdout")) .virtualGatewayName("virtualGateway") .build();
Add a virtual gateway directly to the mesh:
Mesh mesh; VirtualGateway gateway = mesh.addVirtualGateway("gateway", VirtualGatewayBaseProps.builder() .accessLog(AccessLog.fromFilePath("/dev/stdout")) .virtualGatewayName("virtualGateway") .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder() .port(443) .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder() .interval(Duration.seconds(10)) .build())) .build()))) .build());
The listeners
field defaults to an HTTP Listener on port 8080 if omitted.
A gateway route can be added using the gateway.addGatewayRoute()
method.
The backendDefaults
property, provided when creating the virtual gateway, specifies the virtual gateway's default settings for all backends.
A gateway route is attached to a virtual gateway and routes matching traffic to an existing virtual service.
For HTTP-based gateway routes, the match
field can be used to match on
path (prefix, exact, or regex), HTTP method, host name, HTTP headers, and query parameters.
By default, HTTP-based gateway routes match all requests.
VirtualGateway gateway; VirtualService virtualService; gateway.addGatewayRoute("gateway-route-http", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.http(HttpGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(HttpGatewayRouteMatch.builder() .path(HttpGatewayRoutePathMatch.regex("regex")) .build()) .build())) .build());
For gRPC-based gateway routes, the match
field can be used to match on service name, host name, and metadata.
VirtualGateway gateway; VirtualService virtualService; gateway.addGatewayRoute("gateway-route-grpc", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.grpc(GrpcGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(GrpcGatewayRouteMatch.builder() .hostname(GatewayRouteHostnameMatch.endsWith(".example.com")) .build()) .build())) .build());
For HTTP based gateway routes, App Mesh automatically rewrites the matched prefix path in Gateway Route to “/”. This automatic rewrite configuration can be overwritten in following ways:
VirtualGateway gateway; VirtualService virtualService; gateway.addGatewayRoute("gateway-route-http", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.http(HttpGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(HttpGatewayRouteMatch.builder() // This disables the default rewrite to '/', and retains original path. .path(HttpGatewayRoutePathMatch.startsWith("/path-to-app/", "")) .build()) .build())) .build()); gateway.addGatewayRoute("gateway-route-http-1", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.http(HttpGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(HttpGatewayRouteMatch.builder() // If the request full path is '/path-to-app/xxxxx', this rewrites the path to '/rewrittenUri/xxxxx'. // Please note both `prefixPathMatch` and `rewriteTo` must start and end with the `/` character. .path(HttpGatewayRoutePathMatch.startsWith("/path-to-app/", "/rewrittenUri/")) .build()) .build())) .build());
If matching other path (exact or regex), only specific rewrite path can be specified.
Unlike startsWith()
method above, no default rewrite is performed.
VirtualGateway gateway; VirtualService virtualService; gateway.addGatewayRoute("gateway-route-http-2", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.http(HttpGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(HttpGatewayRouteMatch.builder() // This rewrites the path from '/test' to '/rewrittenPath'. .path(HttpGatewayRoutePathMatch.exactly("/test", "/rewrittenPath")) .build()) .build())) .build());
For HTTP/gRPC based routes, App Mesh automatically rewrites
the original request received at the Virtual Gateway to the destination Virtual Service name.
This default host name rewrite can be configured by specifying the rewrite rule as one of the match
property:
VirtualGateway gateway; VirtualService virtualService; gateway.addGatewayRoute("gateway-route-grpc", GatewayRouteBaseProps.builder() .routeSpec(GatewayRouteSpec.grpc(GrpcGatewayRouteSpecOptions.builder() .routeTarget(virtualService) .match(GrpcGatewayRouteMatch.builder() .hostname(GatewayRouteHostnameMatch.exactly("example.com")) // This disables the default rewrite to virtual service name and retain original request. .rewriteRequestHostname(false) .build()) .build())) .build());
Each App Mesh resource class comes with two static methods, from<Resource>Arn
and from<Resource>Attributes
(where <Resource>
is replaced with the resource name, such as VirtualNode
) for importing a reference to an existing App Mesh resource.
These imported resources can be used with other resources in your mesh as if they were defined directly in your CDK application.
String arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh/virtualNode/testNode"; VirtualNode.fromVirtualNodeArn(this, "importedVirtualNode", arn);
String virtualNodeName = "my-virtual-node"; VirtualNode.fromVirtualNodeAttributes(this, "imported-virtual-node", VirtualNodeAttributes.builder() .mesh(Mesh.fromMeshName(this, "Mesh", "testMesh")) .virtualNodeName(virtualNodeName) .build());
To import a mesh, again there are two static methods, fromMeshArn
and fromMeshName
.
String arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh"; Mesh.fromMeshArn(this, "imported-mesh", arn);
Mesh.fromMeshName(this, "imported-mesh", "abc");
VirtualNode
and VirtualGateway
provide grantStreamAggregatedResources
methods that grant identities that are running
Envoy access to stream generated config from App Mesh.
Mesh mesh; VirtualGateway gateway = VirtualGateway.Builder.create(this, "testGateway").mesh(mesh).build(); User envoyUser = new User(this, "envoyUser"); /** * This will grant `grantStreamAggregatedResources` ONLY for this gateway. */ gateway.grantStreamAggregatedResources(envoyUser);
A shared mesh allows resources created by different accounts to communicate with each other in the same mesh:
// This is the ARN for the mesh from different AWS IAM account ID. // Ensure mesh is properly shared with your account. For more details, see: https://github.com/aws/aws-cdk/issues/15404 String arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh"; IMesh sharedMesh = Mesh.fromMeshArn(this, "imported-mesh", arn); // This VirtualNode resource can communicate with the resources in the mesh from different AWS IAM account ID. // This VirtualNode resource can communicate with the resources in the mesh from different AWS IAM account ID. VirtualNode.Builder.create(this, "test-node") .mesh(sharedMesh) .build();