HttpRouteMatch Struct
The criterion for determining a request match for this Route.
Example
ts
declare const router: appmesh.VirtualRouter;
declare const node: appmesh.VirtualNode;
router.addRoute('route-http', {
routeSpec: appmesh.RouteSpec.http({
weightedTargets: [
{
virtualNode: node,
weight: 50,
},
{
virtualNode: node,
weight: 50,
},
],
match: {
path: appmesh.HttpRoutePathMatch.startsWith('/path-to-app'),
},
}),
});
Properties
headersoptionalHeaderMatch[]headersoptionaltyping.List[HeaderMatch]headersoptionalList<HeaderMatch>HeadersoptionalHeaderMatch[]Headersoptional*[]HeaderMatch#Specifies the client request headers to match on.
Default: do not match on headers
All specified headers must match for the route to match.
methodoptionalHttpRouteMethodmethodoptionalHttpRouteMethodmethodoptionalHttpRouteMethodMethodoptionalHttpRouteMethodMethodoptionalHttpRouteMethod#The HTTP client request method to match on.
Default: do not match on request method
pathoptionalHttpRoutePathMatchpathoptionalHttpRoutePathMatchpathoptionalHttpRoutePathMatchPathoptionalHttpRoutePathMatchPathoptionalHttpRoutePathMatch#Specifies how is the request matched based on the path part of its URL.
Default: matches requests with all paths
The port to match from the request.
Default: do not match on port
protocoloptionalHttpRouteProtocolprotocoloptionalHttpRouteProtocolprotocoloptionalHttpRouteProtocolProtocoloptionalHttpRouteProtocolProtocoloptionalHttpRouteProtocol#The client request protocol to match on.
Default: do not match on HTTP2 request protocol
Applicable only for HTTP2 routes.
queryParametersoptionalQueryParameterMatch[]query_parametersoptionaltyping.List[QueryParameterMatch]queryParametersoptionalList<QueryParameterMatch>QueryParametersoptionalQueryParameterMatch[]QueryParametersoptional*[]QueryParameterMatch#The query parameters to match on.
Default: do not match on query parameters
All specified query parameters must match for the route to match.