AWS::AppMesh::Route HttpRouteMatch

An object that represents the requirements for a route to match HTTP requests for a virtual router.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Headers" : [ HttpRouteHeader, ... ],
  "Method" : String,
  "Path" : HttpPathMatch,
  "Port" : Integer,
  "Prefix" : String,
  "QueryParameters" : [ QueryParameter, ... ],
  "Scheme" : String
}

YAML

  Headers: 
    - HttpRouteHeader
  Method: String
  Path: 
    HttpPathMatch
  Port: Integer
  Prefix: String
  QueryParameters: 
    - QueryParameter
  Scheme: String

Properties

Headers

The client request headers to match on.

Required: No

Type: List of HttpRouteHeader

Maximum: 10

Update requires: No interruption

Method

The client request method to match on. Specify only one.

Required: No

Type: String

Allowed values: CONNECT | DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT | TRACE

Update requires: No interruption

Path

The client request path to match on.

Required: No

Type: HttpPathMatch

Update requires: No interruption

Port

The port number to match on.

Required: No

Type: Integer

Minimum: 1

Maximum: 65535

Update requires: No interruption

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 is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

Required: No

Type: String

Update requires: No interruption

QueryParameters

The client request query parameters to match on.

Required: No

Type: List of QueryParameter

Maximum: 10

Update requires: No interruption

Scheme

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

Required: No

Type: String

Allowed values: http | https

Update requires: No interruption