AWS::AppMesh::Route HttpRouteMatch - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

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 CloudFormation template, use the following syntax:

JSON

{
  "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: Array of HttpRouteHeader

Minimum: 1

Maximum: 10

Update requires: No interruption

Method

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

Required: No

Type: String

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

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: Array of QueryParameter

Minimum: 1

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