HttpRouteMatch
An object that represents the requirements for a route to match HTTP requests for a virtual router.
Contents
- headers
-
The client request headers to match on.
Type: Array of HttpRouteHeader objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- method
-
The client request method to match on. Specify only one.
Type: String
Valid Values:
GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH
Required: No
- path
-
The client request path to match on.
Type: HttpPathMatch object
Required: No
- port
-
The port number to match on.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
- prefix
-
Specifies the path to match requests with. This parameter must always start with
/
, 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 ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.Type: String
Required: No
- queryParameters
-
The client request query parameters to match on.
Type: Array of HttpQueryParameter objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- scheme
-
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Type: String
Valid Values:
http | https
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: