AWS App Mesh · Schema
HttpGatewayRouteMatch
An object that represents the criteria for determining a request match.
DeprecatedEnvoyMicroservicesNetworkingService Mesh
Properties
| Name | Type | Description |
|---|---|---|
| headers | object | |
| hostname | object | |
| method | object | |
| path | object | |
| port | object | |
| prefix | object | |
| queryParameters | object |
JSON Schema
{
"type": "object",
"properties": {
"headers": {
"allOf": [
{
"$ref": "#/components/schemas/HttpGatewayRouteHeaders"
},
{
"description": "The client request headers to match on."
}
]
},
"hostname": {
"allOf": [
{
"$ref": "#/components/schemas/GatewayRouteHostnameMatch"
},
{
"description": "The host name to match on."
}
]
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/HttpMethod"
},
{
"description": "The method to match on."
}
]
},
"path": {
"allOf": [
{
"$ref": "#/components/schemas/HttpPathMatch"
},
{
"description": "The path to match on."
}
]
},
"port": {
"allOf": [
{
"$ref": "#/components/schemas/ListenerPort"
},
{
"description": "The port number to match on."
}
]
},
"prefix": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "Specifies the path to match requests with. This parameter must always start with <code>/</code>, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>."
}
]
},
"queryParameters": {
"allOf": [
{
"$ref": "#/components/schemas/HttpQueryParameters"
},
{
"description": "The query parameter to match on."
}
]
}
},
"description": "An object that represents the criteria for determining a request match.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-schema/app-mesh-http-gateway-route-match-schema.json",
"title": "HttpGatewayRouteMatch"
}