Namespace Amazon.CDK.AWS.AppMesh
AWS App Mesh Construct Library
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.
Create the App and Stack
var app = new App();
var stack = new Stack(app, "stack");
Creating the 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.
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.
var mesh = new Mesh(this, "AppMesh", new MeshProps {
MeshName = "myAwsMesh"
});
The mesh can instead be created with the ALLOW_ALL
egress filter by providing the egressFilter
property.
var mesh = new Mesh(this, "AppMesh", new MeshProps {
MeshName = "myAwsMesh",
EgressFilter = MeshFilterType.ALLOW_ALL
});
A mesh with an IP preference can be created by providing the property serviceDiscovery
that specifes an ipPreference
.
var mesh = new Mesh(this, "AppMesh", new MeshProps {
MeshName = "myAwsMesh",
ServiceDiscovery = new MeshServiceDiscovery {
IpPreference = IpPreference.IPV4_ONLY
}
});
Adding VirtualRouters
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;
var router = mesh.AddVirtualRouter("router", new VirtualRouterBaseProps {
Listeners = new [] { VirtualRouterListener.Http(8080) }
});
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;
var mesh = new Mesh(infraStack, "AppMesh", new MeshProps {
MeshName = "myAwsMesh",
EgressFilter = MeshFilterType.ALLOW_ALL
});
// the VirtualRouter will belong to 'appStack',
// even though the Mesh belongs to 'infraStack'
var router = new VirtualRouter(appStack, "router", new VirtualRouterProps {
Mesh = mesh, // notice that mesh is a required property when creating a router with the 'new' statement
Listeners = new [] { VirtualRouterListener.Http(8081) }
});
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.
Adding a VirtualService
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;
new VirtualService(this, "virtual-service", new VirtualServiceProps {
VirtualServiceName = "my-service.default.svc.cluster.local", // optional
VirtualServiceProvider = VirtualServiceProvider.VirtualRouter(router)
});
Adding a virtual node as the provider:
VirtualNode node;
new VirtualService(this, "virtual-service", new VirtualServiceProps {
VirtualServiceName = "my-service.default.svc.cluster.local", // optional
VirtualServiceProvider = VirtualServiceProvider.VirtualNode(node)
});
Adding a VirtualNode
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 by APPMESH_VIRTUAL_NODE_NAME
with the APPMESH_VIRTUAL_NODE_CLUSTER
environment variable.
Mesh mesh;
var vpc = new Vpc(this, "vpc");
var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
Vpc = vpc,
Name = "domain.local"
});
var service = namespace.CreateService("Svc");
var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
ServiceDiscovery = ServiceDiscovery.CloudMap(service),
Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
Port = 8081,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
HealthyThreshold = 3,
Interval = Duration.Seconds(5), // minimum
Path = "/health-check-path",
Timeout = Duration.Seconds(2), // minimum
UnhealthyThreshold = 2
})
}) },
AccessLog = AccessLog.FromFilePath("/dev/stdout")
});
Create a VirtualNode
with the constructor and add tags.
Mesh mesh;
Service service;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.CloudMap(service),
Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
Port = 8080,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
HealthyThreshold = 3,
Interval = Duration.Seconds(5),
Path = "/ping",
Timeout = Duration.Seconds(2),
UnhealthyThreshold = 2
}),
Timeout = new HttpTimeout {
Idle = Duration.Seconds(5)
}
}) },
BackendDefaults = new BackendDefaults {
TlsClientPolicy = new TlsClientPolicy {
Validation = new TlsValidation {
Trust = TlsValidationTrust.File("/keys/local_cert_chain.pem")
}
}
},
AccessLog = AccessLog.FromFilePath("/dev/stdout")
});
Tags.Of(node).Add("Environment", "Dev");
Create a VirtualNode
with the customized access logging format.
Mesh mesh;
Service service;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.CloudMap(service),
Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
Port = 8080,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
HealthyThreshold = 3,
Interval = Duration.Seconds(5),
Path = "/ping",
Timeout = Duration.Seconds(2),
UnhealthyThreshold = 2
}),
Timeout = new HttpTimeout {
Idle = Duration.Seconds(5)
}
}) },
BackendDefaults = new BackendDefaults {
TlsClientPolicy = new TlsClientPolicy {
Validation = new TlsValidation {
Trust = TlsValidationTrust.File("/keys/local_cert_chain.pem")
}
}
},
AccessLog = AccessLog.FromFilePath("/dev/stdout", LoggingFormat.FromJson(new Dictionary<string, string> { { "testKey1", "testValue1" }, { "testKey2", "testValue2" } }))
});
By using a key-value pair indexed signature, you can specify json key pairs to customize the log entry pattern. You can also use text format as below. You can only specify one of these 2 formats.
accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout', appmesh.LoggingFormat.fromText('test_pattern')),
For what values and operators you can use for these two formats, please visit the latest envoy documentation. (https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage)
Create a VirtualNode
with the constructor and add backend virtual service.
Mesh mesh;
VirtualRouter router;
Service service;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.CloudMap(service),
Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
Port = 8080,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
HealthyThreshold = 3,
Interval = Duration.Seconds(5),
Path = "/ping",
Timeout = Duration.Seconds(2),
UnhealthyThreshold = 2
}),
Timeout = new HttpTimeout {
Idle = Duration.Seconds(5)
}
}) },
AccessLog = AccessLog.FromFilePath("/dev/stdout")
});
var virtualService = new VirtualService(this, "service-1", new VirtualServiceProps {
VirtualServiceProvider = VirtualServiceProvider.VirtualRouter(router),
VirtualServiceName = "service1.domain.local"
});
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;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.Dns("node")
});
var virtualService = new VirtualService(this, "service-1", new VirtualServiceProps {
VirtualServiceProvider = VirtualServiceProvider.VirtualNode(node),
VirtualServiceName = "service1.domain.local"
});
node.AddBackend(Backend.VirtualService(virtualService));
Adding TLS to a listener
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:
// A Virtual Node with listener TLS from an ACM provided certificate
Certificate cert;
Mesh mesh;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.Dns("node"),
Listeners = new [] { VirtualNodeListener.Grpc(new GrpcVirtualNodeListenerOptions {
Port = 80,
Tls = new ListenerTlsOptions {
Mode = TlsMode.STRICT,
Certificate = TlsCertificate.Acm(cert)
}
}) }
});
// A Virtual Gateway with listener TLS from a customer provided file certificate
var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
Mesh = mesh,
Listeners = new [] { VirtualGatewayListener.Grpc(new GrpcGatewayListenerOptions {
Port = 8080,
Tls = new ListenerTlsOptions {
Mode = TlsMode.STRICT,
Certificate = TlsCertificate.File("path/to/certChain", "path/to/privateKey")
}
}) },
VirtualGatewayName = "gateway"
});
// A Virtual Gateway with listener TLS from a SDS provided certificate
var gateway2 = new VirtualGateway(this, "gateway2", new VirtualGatewayProps {
Mesh = mesh,
Listeners = new [] { VirtualGatewayListener.Http2(new Http2GatewayListenerOptions {
Port = 8080,
Tls = new ListenerTlsOptions {
Mode = TlsMode.STRICT,
Certificate = TlsCertificate.Sds("secrete_certificate")
}
}) },
VirtualGatewayName = "gateway2"
});
Adding mutual TLS authentication
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:
Note Currently, a certificate from AWS Certificate Manager (ACM) cannot be used for mutual TLS authentication.
Mesh mesh;
var node1 = new VirtualNode(this, "node1", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.Dns("node"),
Listeners = new [] { VirtualNodeListener.Grpc(new GrpcVirtualNodeListenerOptions {
Port = 80,
Tls = new ListenerTlsOptions {
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 = new MutualTlsValidation {
Trust = TlsValidationTrust.File("path-to-certificate")
}
}
}) }
});
var certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";
var node2 = new VirtualNode(this, "node2", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.Dns("node2"),
BackendDefaults = new BackendDefaults {
TlsClientPolicy = new TlsClientPolicy {
Ports = new [] { 8080, 8081 },
Validation = new TlsValidation {
SubjectAlternativeNames = SubjectAlternativeNames.MatchingExactly("mesh-endpoint.apps.local"),
Trust = TlsValidationTrust.Acm(new [] { CertificateAuthority.FromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn) })
},
// Provide a SDS client certificate when a server requests it and enable mutual TLS authentication.
MutualTlsCertificate = TlsCertificate.Sds("secret_certificate")
}
}
});
Adding outlier detection to a Virtual Node listener
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
var vpc = new Vpc(this, "vpc");
var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
Vpc = vpc,
Name = "domain.local"
});
var service = namespace.CreateService("Svc");
var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
ServiceDiscovery = ServiceDiscovery.CloudMap(service),
Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
OutlierDetection = new OutlierDetection {
BaseEjectionDuration = Duration.Seconds(10),
Interval = Duration.Seconds(30),
MaxEjectionPercent = 50,
MaxServerErrors = 5
}
}) }
});
Adding a connection pool to a listener
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;
var node = new VirtualNode(this, "node", new VirtualNodeProps {
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 = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
Port = 80,
ConnectionPool = new HttpConnectionPool {
MaxConnections = 100,
MaxPendingRequests = 10
}
}) }
});
// A Virtual Gateway with a gRPC listener with a connection pool set
var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
Mesh = mesh,
Listeners = new [] { VirtualGatewayListener.Grpc(new GrpcGatewayListenerOptions {
Port = 8080,
ConnectionPool = new GrpcConnectionPool {
MaxRequests = 10
}
}) },
VirtualGatewayName = "gateway"
});
Adding an IP Preference to a Virtual Node
An ipPreference
can be specified as part of a Virtual Node's service discovery. An IP preference defines how clients for this Virtual Node will interact with it.
There a four different IP preferences available to use which each specify what IP versions this Virtual Node will use and prefer.
var mesh = new Mesh(this, "mesh", new MeshProps {
MeshName = "mesh-with-preference"
});
// Virtual Node with DNS service discovery and an IP preference
var dnsNode = new VirtualNode(this, "dns-node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.Dns("test", DnsResponseType.LOAD_BALANCER, IpPreference.IPV4_ONLY)
});
// Virtual Node with CloudMap service discovery and an IP preference
var vpc = new Vpc(this, "vpc");
var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
Vpc = vpc,
Name = "domain.local"
});
var service = namespace.CreateService("Svc");
IDictionary<string, string> instanceAttribute = new Dictionary<string, object> { };
instanceAttribute.TestKey = "testValue";
var cloudmapNode = new VirtualNode(this, "cloudmap-node", new VirtualNodeProps {
Mesh = mesh,
ServiceDiscovery = ServiceDiscovery.CloudMap(service, instanceAttribute, IpPreference.IPV4_ONLY)
});
Adding a Route
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", new RouteBaseProps {
RouteSpec = RouteSpec.Http(new HttpRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget {
VirtualNode = node
} },
Match = new HttpRouteMatch {
// Path that is passed to this method must start with '/'.
Path = HttpRoutePathMatch.StartsWith("/path-to-app")
}
})
});
Add an HTTP2 route that matches based on exact path, method, scheme, headers, and query parameters:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-http2", new RouteBaseProps {
RouteSpec = RouteSpec.Http2(new HttpRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget {
VirtualNode = node
} },
Match = new HttpRouteMatch {
Path = HttpRoutePathMatch.Exactly("/exact"),
Method = HttpRouteMethod.POST,
Protocol = HttpRouteProtocol.HTTPS,
Headers = new [] { HeaderMatch.ValueIs("Content-Type", "application/json"), HeaderMatch.ValueIsNot("Content-Type", "application/json") },
QueryParameters = new [] { QueryParameterMatch.ValueIs("query-field", "value") }
}
})
});
Add a single route with two targets and split traffic 50/50:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-http", new RouteBaseProps {
RouteSpec = RouteSpec.Http(new HttpRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget {
VirtualNode = node,
Weight = 50
}, new WeightedTarget {
VirtualNode = node,
Weight = 50
} },
Match = new HttpRouteMatch {
Path = HttpRoutePathMatch.StartsWith("/path-to-app")
}
})
});
Add an http2 route with retries:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-http2-retry", new RouteBaseProps {
RouteSpec = RouteSpec.Http2(new HttpRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget { VirtualNode = node } },
RetryPolicy = new HttpRetryPolicy {
// Retry if the connection failed
TcpRetryEvents = new [] { TcpRetryEvent.CONNECTION_ERROR },
// Retry if HTTP responds with a gateway error (502, 503, 504)
HttpRetryEvents = new [] { HttpRetryEvent.GATEWAY_ERROR },
// Retry five times
RetryAttempts = 5,
// Use a 1 second timeout per retry
RetryTimeout = Duration.Seconds(1)
}
})
});
Add a gRPC route with retries:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-grpc-retry", new RouteBaseProps {
RouteSpec = RouteSpec.Grpc(new GrpcRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget { VirtualNode = node } },
Match = new GrpcRouteMatch { ServiceName = "servicename" },
RetryPolicy = new GrpcRetryPolicy {
TcpRetryEvents = new [] { TcpRetryEvent.CONNECTION_ERROR },
HttpRetryEvents = new [] { HttpRetryEvent.GATEWAY_ERROR },
// Retry if gRPC responds that the request was cancelled, a resource
// was exhausted, or if the service is unavailable
GrpcRetryEvents = new [] { GrpcRetryEvent.CANCELLED, GrpcRetryEvent.RESOURCE_EXHAUSTED, GrpcRetryEvent.UNAVAILABLE },
RetryAttempts = 5,
RetryTimeout = Duration.Seconds(1)
}
})
});
Add an gRPC route that matches based on method name and metadata:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-grpc-retry", new RouteBaseProps {
RouteSpec = RouteSpec.Grpc(new GrpcRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget { VirtualNode = node } },
Match = new GrpcRouteMatch {
// When method name is specified, service name must be also specified.
MethodName = "methodname",
ServiceName = "servicename",
Metadata = new [] { HeaderMatch.ValueStartsWith("Content-Type", "application/"), HeaderMatch.ValueDoesNotStartWith("Content-Type", "text/") }
}
})
});
Add a gRPC route that matches based on port:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-grpc-port", new RouteBaseProps {
RouteSpec = RouteSpec.Grpc(new GrpcRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget {
VirtualNode = node
} },
Match = new GrpcRouteMatch {
Port = 1234
}
})
});
Add a gRPC route with timeout:
VirtualRouter router;
VirtualNode node;
router.AddRoute("route-http", new RouteBaseProps {
RouteSpec = RouteSpec.Grpc(new GrpcRouteSpecOptions {
WeightedTargets = new [] { new WeightedTarget {
VirtualNode = node
} },
Match = new GrpcRouteMatch {
ServiceName = "my-service.default.svc.cluster.local"
},
Timeout = new GrpcTimeout {
Idle = Duration.Seconds(2),
PerRequest = Duration.Seconds(1)
}
})
});
Adding a Virtual Gateway
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;
var certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";
var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
Mesh = mesh,
Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
Port = 443,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
Interval = Duration.Seconds(10)
})
}) },
BackendDefaults = new BackendDefaults {
TlsClientPolicy = new TlsClientPolicy {
Ports = new [] { 8080, 8081 },
Validation = new TlsValidation {
Trust = TlsValidationTrust.Acm(new [] { CertificateAuthority.FromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn) })
}
}
},
AccessLog = AccessLog.FromFilePath("/dev/stdout"),
VirtualGatewayName = "virtualGateway"
});
Add a virtual gateway directly to the mesh:
Mesh mesh;
var gateway = mesh.AddVirtualGateway("gateway", new VirtualGatewayBaseProps {
AccessLog = AccessLog.FromFilePath("/dev/stdout"),
VirtualGatewayName = "virtualGateway",
Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
Port = 443,
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
Interval = Duration.Seconds(10)
})
}) }
});
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.
Adding a Gateway Route
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", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Http(new HttpGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new HttpGatewayRouteMatch {
Path = HttpGatewayRoutePathMatch.Regex("regex")
}
})
});
For gRPC-based gateway routes, the match
field can be used to match on service name, host name, port and metadata.
VirtualGateway gateway;
VirtualService virtualService;
gateway.AddGatewayRoute("gateway-route-grpc", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Grpc(new GrpcGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new GrpcGatewayRouteMatch {
Hostname = GatewayRouteHostnameMatch.EndsWith(".example.com")
}
})
});
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", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Http(new HttpGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new HttpGatewayRouteMatch {
// This disables the default rewrite to '/', and retains original path.
Path = HttpGatewayRoutePathMatch.StartsWith("/path-to-app/", "")
}
})
});
gateway.AddGatewayRoute("gateway-route-http-1", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Http(new HttpGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new HttpGatewayRouteMatch {
// 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/")
}
})
});
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", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Http(new HttpGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new HttpGatewayRouteMatch {
// This rewrites the path from '/test' to '/rewrittenPath'.
Path = HttpGatewayRoutePathMatch.Exactly("/test", "/rewrittenPath")
}
})
});
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", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Grpc(new GrpcGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new GrpcGatewayRouteMatch {
Hostname = GatewayRouteHostnameMatch.Exactly("example.com"),
// This disables the default rewrite to virtual service name and retain original request.
RewriteRequestHostname = false
}
})
});
Importing Resources
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.
var arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh/virtualNode/testNode";
VirtualNode.FromVirtualNodeArn(this, "importedVirtualNode", arn);
var virtualNodeName = "my-virtual-node";
VirtualNode.FromVirtualNodeAttributes(this, "imported-virtual-node", new VirtualNodeAttributes {
Mesh = Mesh.FromMeshName(this, "Mesh", "testMesh"),
VirtualNodeName = virtualNodeName
});
To import a mesh, again there are two static methods, fromMeshArn
and fromMeshName
.
var arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh";
Mesh.FromMeshArn(this, "imported-mesh", arn);
Mesh.FromMeshName(this, "imported-mesh", "abc");
IAM Grants
VirtualNode
and VirtualGateway
provide grantStreamAggregatedResources
methods that grant identities that are running
Envoy access to stream generated config from App Mesh.
Mesh mesh;
var gateway = new VirtualGateway(this, "testGateway", new VirtualGatewayProps { Mesh = mesh });
var envoyUser = new User(this, "envoyUser");
/**
* This will grant `grantStreamAggregatedResources` ONLY for this gateway.
*/
gateway.GrantStreamAggregatedResources(envoyUser);
Adding Resources to shared meshes
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
var arn = "arn:aws:appmesh:us-east-1:123456789012:mesh/testMesh";
var 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.
new VirtualNode(this, "test-node", new VirtualNodeProps {
Mesh = sharedMesh
});
Classes
AccessLog | Configuration for Envoy Access logs for mesh endpoints. |
AccessLogConfig | All Properties for Envoy Access logs for mesh endpoints. |
Backend | Contains static factory methods to create backends. |
BackendConfig | Properties for a backend. |
BackendDefaults | Represents the properties needed to define backend defaults. |
CfnGatewayRoute | Creates a gateway route. |
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 |
CfnMesh | Creates a service mesh. |
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 |
CfnRoute | Creates a route that is associated with a virtual router. |
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 |
CfnVirtualGateway | Creates a virtual gateway. |
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. See App Mesh TLS documentation for more info. |
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 |
CfnVirtualNode | Creates a virtual node within a service mesh. |
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 |
CfnVirtualRouter | Creates a virtual router within a service mesh. |
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 |
CfnVirtualService | Creates a virtual service within a service mesh. |
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 |
CommonGatewayRouteSpecOptions | Base options for all gateway route specs. |
DnsResponseType | Enum of DNS service discovery response type. |
GatewayRoute | GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh. |
GatewayRouteAttributes | Interface with properties necessary to import a reusable GatewayRoute. |
GatewayRouteBaseProps | Basic configuration properties for a GatewayRoute. |
GatewayRouteHostnameMatch | Used to generate host name matching methods. |
GatewayRouteHostnameMatchConfig | Configuration for gateway route host name match. |
GatewayRouteProps | Properties to define a new GatewayRoute. |
GatewayRouteSpec | Used to generate specs with different protocols for a 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. |
GrpcRetryEvent | gRPC events. |
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 property. |
HeaderMatch | Used to generate header matching methods. |
HeaderMatchConfig | Configuration for |
HealthCheck | Contains static factory methods for creating health checks for different protocols. |
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 property. |
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. |
HttpGatewayRoutePathMatch | Defines HTTP gateway route matching based on the URL path of the request. |
HttpGatewayRoutePathMatchConfig | The type returned from the |
HttpGatewayRouteSpecOptions | Properties specific for HTTP Based GatewayRoutes. |
HttpHealthCheckOptions | Properties used to define HTTP Based healthchecks. |
HttpRetryEvent | HTTP events on which to retry. |
HttpRetryPolicy | HTTP retry policy. |
HttpRouteMatch | The criterion for determining a request match for this Route. |
HttpRouteMethod | Supported values for matching routes based on the HTTP request method. |
HttpRoutePathMatch | Defines HTTP route matching based on the URL path of the request. |
HttpRoutePathMatchConfig | The type returned from the |
HttpRouteProtocol | Supported :scheme options for HTTP2. |
HttpRouteSpecOptions | Properties specific for HTTP Based Routes. |
HttpTimeout | Represents timeouts for HTTP protocols. |
HttpVirtualNodeListenerOptions | Represent the HTTP Node Listener property. |
IpPreference | Enum of supported IP preferences. |
ListenerTlsOptions | Represents TLS properties for listener. |
LoggingFormat | Configuration for Envoy Access Logging Format for mesh endpoints. |
LoggingFormatConfig | All Properties for Envoy Access Logging Format for mesh endpoints. |
Mesh | Define a new AppMesh mesh. |
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. |
MeshProps | The set of properties used when creating a Mesh. |
MeshServiceDiscovery | Properties for Mesh Service Discovery. |
MutualTlsCertificate | Represents a TLS certificate that is supported for mutual TLS authentication. |
MutualTlsValidation | Represents the properties needed to define TLS Validation context that is supported for mutual TLS authentication. |
MutualTlsValidationTrust | Represents a TLS Validation Context Trust that is supported for mutual TLS authentication. |
OutlierDetection | Represents the outlier detection for a listener. |
QueryParameterMatch | Used to generate query parameter matching methods. |
QueryParameterMatchConfig | Configuration for |
Route | Route represents a new or existing route attached to a VirtualRouter and Mesh. |
RouteAttributes | Interface with properties ncecessary to import a reusable Route. |
RouteBaseProps | Base interface properties for all Routes. |
RouteProps | Properties to define new Routes. |
RouteSpec | Used to generate specs with different protocols for a RouteSpec. |
RouteSpecConfig | All Properties for Route Specs. |
RouteSpecOptionsBase | Base options for all route specs. |
ServiceDiscovery | Provides the Service Discovery method a VirtualNode uses. |
ServiceDiscoveryConfig | Properties for VirtualNode Service Discovery. |
SubjectAlternativeNames | Used to generate Subject Alternative Names Matchers. |
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. |
TcpRetryEvent | TCP events on which you may retry. |
TcpRouteSpecOptions | Properties specific for a TCP Based Routes. |
TcpTimeout | Represents timeouts for TCP protocols. |
TcpVirtualNodeListenerOptions | Represent the TCP Node Listener property. |
TlsCertificate | Represents a TLS certificate. |
TlsCertificateConfig | A wrapper for the tls config returned by |
TlsClientPolicy | Represents the properties needed to define client policy. |
TlsMode | Enum of supported TLS modes. |
TlsValidation | Represents the properties needed to define TLS Validation context. |
TlsValidationTrust | Defines the TLS Validation Context Trust. |
TlsValidationTrustConfig | All Properties for TLS Validation Trusts for both Client Policy and Listener. |
VirtualGateway | VirtualGateway represents a newly defined App Mesh Virtual Gateway. |
VirtualGatewayAttributes | Unterface with properties necessary to import a reusable VirtualGateway. |
VirtualGatewayBaseProps | Basic configuration properties for a VirtualGateway. |
VirtualGatewayListener | Represents the properties needed to define listeners for a VirtualGateway. |
VirtualGatewayListenerConfig | Properties for a VirtualGateway listener. |
VirtualGatewayProps | Properties used when creating a new VirtualGateway. |
VirtualNode | VirtualNode represents a newly defined AppMesh VirtualNode. |
VirtualNodeAttributes | Interface with properties necessary to import a reusable VirtualNode. |
VirtualNodeBaseProps | Basic configuration properties for a VirtualNode. |
VirtualNodeListener | Defines listener for a VirtualNode. |
VirtualNodeListenerConfig | Properties for a VirtualNode listener. |
VirtualNodeProps | The properties used when creating a new VirtualNode. |
VirtualRouter | |
VirtualRouterAttributes | Interface with properties ncecessary to import a reusable VirtualRouter. |
VirtualRouterBaseProps | Interface with base properties all routers willl inherit. |
VirtualRouterListener | Represents the properties needed to define listeners for a VirtualRouter. |
VirtualRouterListenerConfig | Properties for a VirtualRouter listener. |
VirtualRouterProps | The properties used when creating a new VirtualRouter. |
VirtualService | VirtualService represents a service inside an AppMesh. |
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. |
VirtualServiceProvider | Represents the properties needed to define the provider for a VirtualService. |
VirtualServiceProviderConfig | Properties for a VirtualService provider. |
WeightedTarget | Properties for the Weighted Targets in the route. |
Interfaces
CfnGatewayRoute.IGatewayRouteHostnameMatchProperty | An object representing the gateway route host name to match. |
CfnGatewayRoute.IGatewayRouteHostnameRewriteProperty | An object representing the gateway route host name to rewrite. |
CfnGatewayRoute.IGatewayRouteMetadataMatchProperty | An object representing the method header to be matched. |
CfnGatewayRoute.IGatewayRouteRangeMatchProperty | An object that represents the range of values to match on. |
CfnGatewayRoute.IGatewayRouteSpecProperty | An object that represents a gateway route specification. |
CfnGatewayRoute.IGatewayRouteTargetProperty | An object that represents a gateway route target. |
CfnGatewayRoute.IGatewayRouteVirtualServiceProperty | An object that represents the virtual service that traffic is routed to. |
CfnGatewayRoute.IGrpcGatewayRouteActionProperty | An object that represents the action to take if a match is determined. |
CfnGatewayRoute.IGrpcGatewayRouteMatchProperty | An object that represents the criteria for determining a request match. |
CfnGatewayRoute.IGrpcGatewayRouteMetadataProperty | An object representing the metadata of the gateway route. |
CfnGatewayRoute.IGrpcGatewayRouteProperty | An object that represents a gRPC gateway route. |
CfnGatewayRoute.IGrpcGatewayRouteRewriteProperty | An object that represents the gateway route to rewrite. |
CfnGatewayRoute.IHttpGatewayRouteActionProperty | An object that represents the action to take if a match is determined. |
CfnGatewayRoute.IHttpGatewayRouteHeaderMatchProperty | An object that represents the method and value to match with the header value sent in a request. |
CfnGatewayRoute.IHttpGatewayRouteHeaderProperty | An object that represents the HTTP header in the gateway route. |
CfnGatewayRoute.IHttpGatewayRouteMatchProperty | An object that represents the criteria for determining a request match. |
CfnGatewayRoute.IHttpGatewayRoutePathRewriteProperty | An object that represents the path to rewrite. |
CfnGatewayRoute.IHttpGatewayRoutePrefixRewriteProperty | An object representing the beginning characters of the route to rewrite. |
CfnGatewayRoute.IHttpGatewayRouteProperty | An object that represents an HTTP gateway route. |
CfnGatewayRoute.IHttpGatewayRouteRewriteProperty | An object representing the gateway route to rewrite. |
CfnGatewayRoute.IHttpPathMatchProperty | An object representing the path to match in the request. |
CfnGatewayRoute.IHttpQueryParameterMatchProperty | An object representing the query parameter to match. |
CfnGatewayRoute.IQueryParameterProperty | An object that represents the query parameter in the request. |
CfnMesh.IEgressFilterProperty | An object that represents the egress filter rules for a service mesh. |
CfnMesh.IMeshServiceDiscoveryProperty | An object that represents the service discovery information for a service mesh. |
CfnMesh.IMeshSpecProperty | An object that represents the specification of a service mesh. |
CfnRoute.IDurationProperty | An object that represents a duration of time. |
CfnRoute.IGrpcRetryPolicyProperty | An object that represents a retry policy. |
CfnRoute.IGrpcRouteActionProperty | An object that represents the action to take if a match is determined. |
CfnRoute.IGrpcRouteMatchProperty | An object that represents the criteria for determining a request match. |
CfnRoute.IGrpcRouteMetadataMatchMethodProperty | An object that represents the match method. |
CfnRoute.IGrpcRouteMetadataProperty | An object that represents the match metadata for the route. |
CfnRoute.IGrpcRouteProperty | An object that represents a gRPC route type. |
CfnRoute.IGrpcTimeoutProperty | An object that represents types of timeouts. |
CfnRoute.IHeaderMatchMethodProperty | An object that represents the method and value to match with the header value sent in a request. |
CfnRoute.IHttpPathMatchProperty | An object representing the path to match in the request. |
CfnRoute.IHttpQueryParameterMatchProperty | An object representing the query parameter to match. |
CfnRoute.IHttpRetryPolicyProperty | An object that represents a retry policy. |
CfnRoute.IHttpRouteActionProperty | An object that represents the action to take if a match is determined. |
CfnRoute.IHttpRouteHeaderProperty | An object that represents the HTTP header in the request. |
CfnRoute.IHttpRouteMatchProperty | An object that represents the requirements for a route to match HTTP requests for a virtual router. |
CfnRoute.IHttpRouteProperty | An object that represents an HTTP or HTTP/2 route type. |
CfnRoute.IHttpTimeoutProperty | An object that represents types of timeouts. |
CfnRoute.IMatchRangeProperty | An object that represents the range of values to match on. |
CfnRoute.IQueryParameterProperty | An object that represents the query parameter in the request. |
CfnRoute.IRouteSpecProperty | An object that represents a route specification. |
CfnRoute.ITcpRouteActionProperty | An object that represents the action to take if a match is determined. |
CfnRoute.ITcpRouteMatchProperty | An object representing the TCP route to match. |
CfnRoute.ITcpRouteProperty | An object that represents a TCP route type. |
CfnRoute.ITcpTimeoutProperty | An object that represents types of timeouts. |
CfnRoute.IWeightedTargetProperty | An object that represents a target and its relative weight. |
CfnVirtualGateway.IJsonFormatRefProperty | An object that represents the key value pairs for the JSON. |
CfnVirtualGateway.ILoggingFormatProperty | An object that represents the format for the logs. |
CfnVirtualGateway.ISubjectAlternativeNameMatchersProperty | An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched. |
CfnVirtualGateway.ISubjectAlternativeNamesProperty | An object that represents the subject alternative names secured by the certificate. |
CfnVirtualGateway.IVirtualGatewayAccessLogProperty | The access log configuration for a virtual gateway. |
CfnVirtualGateway.IVirtualGatewayBackendDefaultsProperty | An object that represents the default properties for a backend. |
CfnVirtualGateway.IVirtualGatewayClientPolicyProperty | An object that represents a client policy. |
CfnVirtualGateway.IVirtualGatewayClientPolicyTlsProperty | An object that represents a Transport Layer Security (TLS) client policy. |
CfnVirtualGateway.IVirtualGatewayClientTlsCertificateProperty | An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate. |
CfnVirtualGateway.IVirtualGatewayConnectionPoolProperty | An object that represents the type of virtual gateway connection pool. |
CfnVirtualGateway.IVirtualGatewayFileAccessLogProperty | An object that represents an access log file. |
CfnVirtualGateway.IVirtualGatewayGrpcConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualGateway.IVirtualGatewayHealthCheckPolicyProperty | An object that represents the health check policy for a virtual gateway's listener. |
CfnVirtualGateway.IVirtualGatewayHttp2ConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualGateway.IVirtualGatewayHttpConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualGateway.IVirtualGatewayListenerProperty | An object that represents a listener for a virtual gateway. |
CfnVirtualGateway.IVirtualGatewayListenerTlsAcmCertificateProperty | An object that represents an AWS Certificate Manager certificate. |
CfnVirtualGateway.IVirtualGatewayListenerTlsCertificateProperty | An object that represents a listener's Transport Layer Security (TLS) certificate. |
CfnVirtualGateway.IVirtualGatewayListenerTlsFileCertificateProperty | An object that represents a local file certificate. |
CfnVirtualGateway.IVirtualGatewayListenerTlsProperty | An object that represents the Transport Layer Security (TLS) properties for a listener. |
CfnVirtualGateway.IVirtualGatewayListenerTlsSdsCertificateProperty | 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 Mesh TLS documentation for more info. |
CfnVirtualGateway.IVirtualGatewayListenerTlsValidationContextProperty | An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context. |
CfnVirtualGateway.IVirtualGatewayListenerTlsValidationContextTrustProperty | An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust. |
CfnVirtualGateway.IVirtualGatewayLoggingProperty | An object that represents logging information. |
CfnVirtualGateway.IVirtualGatewayPortMappingProperty | An object that represents a port mapping. |
CfnVirtualGateway.IVirtualGatewaySpecProperty | An object that represents the specification of a service mesh resource. |
CfnVirtualGateway.IVirtualGatewayTlsValidationContextAcmTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate. |
CfnVirtualGateway.IVirtualGatewayTlsValidationContextFileTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust for a local file. |
CfnVirtualGateway.IVirtualGatewayTlsValidationContextProperty | An object that represents a Transport Layer Security (TLS) validation context. |
CfnVirtualGateway.IVirtualGatewayTlsValidationContextSdsTrustProperty | An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. |
CfnVirtualGateway.IVirtualGatewayTlsValidationContextTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust. |
CfnVirtualNode.IAccessLogProperty | An object that represents the access logging information for a virtual node. |
CfnVirtualNode.IAwsCloudMapInstanceAttributeProperty | An object that represents the AWS Cloud Map attribute information for your virtual node. |
CfnVirtualNode.IAwsCloudMapServiceDiscoveryProperty | An object that represents the AWS Cloud Map service discovery information for your virtual node. |
CfnVirtualNode.IBackendDefaultsProperty | An object that represents the default properties for a backend. |
CfnVirtualNode.IBackendProperty | An object that represents the backends that a virtual node is expected to send outbound traffic to. |
CfnVirtualNode.IClientPolicyProperty | An object that represents a client policy. |
CfnVirtualNode.IClientPolicyTlsProperty | A reference to an object that represents a Transport Layer Security (TLS) client policy. |
CfnVirtualNode.IClientTlsCertificateProperty | An object that represents the client's certificate. |
CfnVirtualNode.IDnsServiceDiscoveryProperty | An object that represents the DNS service discovery information for your virtual node. |
CfnVirtualNode.IDurationProperty | An object that represents a duration of time. |
CfnVirtualNode.IFileAccessLogProperty | An object that represents an access log file. |
CfnVirtualNode.IGrpcTimeoutProperty | An object that represents types of timeouts. |
CfnVirtualNode.IHealthCheckProperty | An object that represents the health check policy for a virtual node's listener. |
CfnVirtualNode.IHttpTimeoutProperty | An object that represents types of timeouts. |
CfnVirtualNode.IJsonFormatRefProperty | An object that represents the key value pairs for the JSON. |
CfnVirtualNode.IListenerProperty | An object that represents a listener for a virtual node. |
CfnVirtualNode.IListenerTimeoutProperty | An object that represents timeouts for different protocols. |
CfnVirtualNode.IListenerTlsAcmCertificateProperty | An object that represents an AWS Certificate Manager certificate. |
CfnVirtualNode.IListenerTlsCertificateProperty | An object that represents a listener's Transport Layer Security (TLS) certificate. |
CfnVirtualNode.IListenerTlsFileCertificateProperty | An object that represents a local file certificate. |
CfnVirtualNode.IListenerTlsProperty | An object that represents the Transport Layer Security (TLS) properties for a listener. |
CfnVirtualNode.IListenerTlsSdsCertificateProperty | An object that represents the listener's Secret Discovery Service certificate. |
CfnVirtualNode.IListenerTlsValidationContextProperty | An object that represents a listener's Transport Layer Security (TLS) validation context. |
CfnVirtualNode.IListenerTlsValidationContextTrustProperty | An object that represents a listener's Transport Layer Security (TLS) validation context trust. |
CfnVirtualNode.ILoggingFormatProperty | An object that represents the format for the logs. |
CfnVirtualNode.ILoggingProperty | An object that represents the logging information for a virtual node. |
CfnVirtualNode.IOutlierDetectionProperty | An object that represents the outlier detection for a virtual node's listener. |
CfnVirtualNode.IPortMappingProperty | An object representing a virtual node or virtual router listener port mapping. |
CfnVirtualNode.IServiceDiscoveryProperty | An object that represents the service discovery information for a virtual node. |
CfnVirtualNode.ISubjectAlternativeNameMatchersProperty | An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched. |
CfnVirtualNode.ISubjectAlternativeNamesProperty | An object that represents the subject alternative names secured by the certificate. |
CfnVirtualNode.ITcpTimeoutProperty | An object that represents types of timeouts. |
CfnVirtualNode.ITlsValidationContextAcmTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certificate Manager certificate. |
CfnVirtualNode.ITlsValidationContextFileTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust for a local file. |
CfnVirtualNode.ITlsValidationContextProperty | An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation. |
CfnVirtualNode.ITlsValidationContextSdsTrustProperty | An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. |
CfnVirtualNode.ITlsValidationContextTrustProperty | An object that represents a Transport Layer Security (TLS) validation context trust. |
CfnVirtualNode.IVirtualNodeConnectionPoolProperty | An object that represents the type of virtual node connection pool. |
CfnVirtualNode.IVirtualNodeGrpcConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualNode.IVirtualNodeHttp2ConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualNode.IVirtualNodeHttpConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualNode.IVirtualNodeSpecProperty | An object that represents the specification of a virtual node. |
CfnVirtualNode.IVirtualNodeTcpConnectionPoolProperty | An object that represents a type of connection pool. |
CfnVirtualNode.IVirtualServiceBackendProperty | An object that represents a virtual service backend for a virtual node. |
CfnVirtualRouter.IPortMappingProperty | An object representing a virtual router listener port mapping. |
CfnVirtualRouter.IVirtualRouterListenerProperty | An object that represents a virtual router listener. |
CfnVirtualRouter.IVirtualRouterSpecProperty | An object that represents the specification of a virtual router. |
CfnVirtualService.IVirtualNodeServiceProviderProperty | An object that represents a virtual node service provider. |
CfnVirtualService.IVirtualRouterServiceProviderProperty | An object that represents a virtual node service provider. |
CfnVirtualService.IVirtualServiceProviderProperty | An object that represents the provider for a virtual service. |
CfnVirtualService.IVirtualServiceSpecProperty | An object that represents the specification of a virtual service. |
IAccessLogConfig | All Properties for Envoy Access logs for mesh endpoints. |
IBackendConfig | Properties for a backend. |
IBackendDefaults | Represents the properties needed to define backend defaults. |
ICfnGatewayRouteProps | Properties for defining a |
ICfnMeshProps | Properties for defining a |
ICfnRouteProps | Properties for defining a |
ICfnVirtualGatewayProps | Properties for defining a |
ICfnVirtualNodeProps | Properties for defining a |
ICfnVirtualRouterProps | Properties for defining a |
ICfnVirtualServiceProps | Properties for defining a |
ICommonGatewayRouteSpecOptions | Base options for all gateway route specs. |
IGatewayRoute | Interface for which all GatewayRoute based classes MUST implement. |
IGatewayRouteAttributes | Interface with properties necessary to import a reusable GatewayRoute. |
IGatewayRouteBaseProps | Basic configuration properties for a GatewayRoute. |
IGatewayRouteHostnameMatchConfig | Configuration for gateway route host name match. |
IGatewayRouteProps | Properties to define a new GatewayRoute. |
IGatewayRouteSpecConfig | All Properties for GatewayRoute Specs. |
IGrpcConnectionPool | Connection pool properties for gRPC listeners. |
IGrpcGatewayListenerOptions | Represents the properties needed to define GRPC Listeners for a VirtualGateway. |
IGrpcGatewayRouteMatch | The criterion for determining a request match for this GatewayRoute. |
IGrpcGatewayRouteSpecOptions | Properties specific for a gRPC GatewayRoute. |
IGrpcHealthCheckOptions | Properties used to define GRPC Based healthchecks. |
IGrpcRetryPolicy | gRPC retry policy. |
IGrpcRouteMatch | The criterion for determining a request match for this Route. |
IGrpcRouteSpecOptions | Properties specific for a GRPC Based Routes. |
IGrpcTimeout | Represents timeouts for GRPC protocols. |
IGrpcVirtualNodeListenerOptions | Represent the GRPC Node Listener property. |
IHeaderMatchConfig | Configuration for |
IHealthCheckBindOptions | Options used for creating the Health Check object. |
IHealthCheckConfig | All Properties for Health Checks for mesh endpoints. |
IHttp2ConnectionPool | Connection pool properties for HTTP2 listeners. |
IHttp2GatewayListenerOptions | Represents the properties needed to define HTTP2 Listeners for a VirtualGateway. |
IHttp2VirtualNodeListenerOptions | Represent the HTTP2 Node Listener property. |
IHttpConnectionPool | Connection pool properties for HTTP listeners. |
IHttpGatewayListenerOptions | Represents the properties needed to define HTTP Listeners for a VirtualGateway. |
IHttpGatewayRouteMatch | The criterion for determining a request match for this GatewayRoute. |
IHttpGatewayRoutePathMatchConfig | The type returned from the |
IHttpGatewayRouteSpecOptions | Properties specific for HTTP Based GatewayRoutes. |
IHttpHealthCheckOptions | Properties used to define HTTP Based healthchecks. |
IHttpRetryPolicy | HTTP retry policy. |
IHttpRouteMatch | The criterion for determining a request match for this Route. |
IHttpRoutePathMatchConfig | The type returned from the |
IHttpRouteSpecOptions | Properties specific for HTTP Based Routes. |
IHttpTimeout | Represents timeouts for HTTP protocols. |
IHttpVirtualNodeListenerOptions | Represent the HTTP Node Listener property. |
IListenerTlsOptions | Represents TLS properties for listener. |
ILoggingFormatConfig | All Properties for Envoy Access Logging Format for mesh endpoints. |
IMesh | Interface which all Mesh based classes MUST implement. |
IMeshProps | The set of properties used when creating a Mesh. |
IMeshServiceDiscovery | Properties for Mesh Service Discovery. |
IMutualTlsValidation | Represents the properties needed to define TLS Validation context that is supported for mutual TLS authentication. |
IOutlierDetection | Represents the outlier detection for a listener. |
IQueryParameterMatchConfig | Configuration for |
IRoute | Interface for which all Route based classes MUST implement. |
IRouteAttributes | Interface with properties ncecessary to import a reusable Route. |
IRouteBaseProps | Base interface properties for all Routes. |
IRouteProps | Properties to define new Routes. |
IRouteSpecConfig | All Properties for Route Specs. |
IRouteSpecOptionsBase | Base options for all route specs. |
IServiceDiscoveryConfig | Properties for VirtualNode Service Discovery. |
ISubjectAlternativeNamesMatcherConfig | All Properties for Subject Alternative Names Matcher for both Client Policy and Listener. |
ITcpConnectionPool | Connection pool properties for TCP listeners. |
ITcpHealthCheckOptions | Properties used to define TCP Based healthchecks. |
ITcpRouteSpecOptions | Properties specific for a TCP Based Routes. |
ITcpTimeout | Represents timeouts for TCP protocols. |
ITcpVirtualNodeListenerOptions | Represent the TCP Node Listener property. |
ITlsCertificateConfig | A wrapper for the tls config returned by |
ITlsClientPolicy | Represents the properties needed to define client policy. |
ITlsValidation | Represents the properties needed to define TLS Validation context. |
ITlsValidationTrustConfig | All Properties for TLS Validation Trusts for both Client Policy and Listener. |
IVirtualGateway | Interface which all Virtual Gateway based classes must implement. |
IVirtualGatewayAttributes | Unterface with properties necessary to import a reusable VirtualGateway. |
IVirtualGatewayBaseProps | Basic configuration properties for a VirtualGateway. |
IVirtualGatewayListenerConfig | Properties for a VirtualGateway listener. |
IVirtualGatewayProps | Properties used when creating a new VirtualGateway. |
IVirtualNode | Interface which all VirtualNode based classes must implement. |
IVirtualNodeAttributes | Interface with properties necessary to import a reusable VirtualNode. |
IVirtualNodeBaseProps | Basic configuration properties for a VirtualNode. |
IVirtualNodeListenerConfig | Properties for a VirtualNode listener. |
IVirtualNodeProps | The properties used when creating a new VirtualNode. |
IVirtualRouter | Interface which all VirtualRouter based classes MUST implement. |
IVirtualRouterAttributes | Interface with properties ncecessary to import a reusable VirtualRouter. |
IVirtualRouterBaseProps | Interface with base properties all routers willl inherit. |
IVirtualRouterListenerConfig | Properties for a VirtualRouter listener. |
IVirtualRouterProps | The properties used when creating a new VirtualRouter. |
IVirtualService | Represents the interface which all VirtualService based classes MUST implement. |
IVirtualServiceAttributes | Interface with properties ncecessary to import a reusable VirtualService. |
IVirtualServiceBackendOptions | Represents the properties needed to define a Virtual Service backend. |
IVirtualServiceProps | The properties applied to the VirtualService being defined. |
IVirtualServiceProviderConfig | Properties for a VirtualService provider. |
IWeightedTarget | Properties for the Weighted Targets in the route. |