AWS::AppMesh::GatewayRoute HttpGatewayRouteMatch - AWS CloudFormation
SyntaxProperties

AWS::AppMesh::GatewayRoute HttpGatewayRouteMatch

An object that represents the criteria for determining a request match.

Syntax

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

JSON

{
  "Headers" : [ HttpGatewayRouteHeader, ... ],
  "Hostname" : GatewayRouteHostnameMatch,
  "Method" : String,
  "Path" : HttpPathMatch,
  "Port" : Integer,
  "Prefix" : String,
  "QueryParameters" : [ QueryParameter, ... ]
}

Properties

Headers

The client request headers to match on.

Required: No

Type: Array of HttpGatewayRouteHeader

Minimum: 1

Maximum: 10

Update requires: No interruption

Hostname

The host name to match on.

Required: No

Type: GatewayRouteHostnameMatch

Update requires: No interruption

Method

The method to match on.

Required: No

Type: String

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

Update requires: No interruption

Path

The 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 query parameter to match on.

Required: No

Type: Array of QueryParameter

Minimum: 1

Maximum: 10

Update requires: No interruption