interface HttpGatewayRouteMatchProperty

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnGatewayRoute_HttpGatewayRouteMatchProperty
Java	software.amazon.awscdk.services.appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty
Python	aws_cdk.aws_appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty
TypeScript	aws-cdk-lib » aws_appmesh » CfnGatewayRoute » HttpGatewayRouteMatchProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const httpGatewayRouteMatchProperty: appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty = {
  headers: [{
    name: 'name',

    // the properties below are optional
    invert: false,
    match: {
      exact: 'exact',
      prefix: 'prefix',
      range: {
        end: 123,
        start: 123,
      },
      regex: 'regex',
      suffix: 'suffix',
    },
  }],
  hostname: {
    exact: 'exact',
    suffix: 'suffix',
  },
  method: 'method',
  path: {
    exact: 'exact',
    regex: 'regex',
  },
  port: 123,
  prefix: 'prefix',
  queryParameters: [{
    name: 'name',

    // the properties below are optional
    match: {
      exact: 'exact',
    },
  }],
};

Properties

Name	Type	Description
headers?	IResolvable | (IResolvable | HttpGatewayRouteHeaderProperty)[]	The client request headers to match on.
hostname?	IResolvable | GatewayRouteHostnameMatchProperty	The host name to match on.
method?	string	The method to match on.
path?	IResolvable | HttpPathMatchProperty	The path to match on.
port?	number	The port number to match on.
prefix?	string	Specifies the path to match requests with.
queryParameters?	IResolvable | (IResolvable | QueryParameterProperty)[]	The query parameter to match on.

---

headers?

Type: IResolvable | (IResolvable | HttpGatewayRouteHeaderProperty)[] (optional)

The client request headers to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers

---

hostname?

Type: IResolvable | GatewayRouteHostnameMatchProperty (optional)

The host name to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname

---

method?

Type: string (optional)

The method to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method

---

path?

Type: IResolvable | HttpPathMatchProperty (optional)

The path to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path

---

port?

Type: number (optional)

The port number to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-port

---

prefix?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix

---

queryParameters?

Type: IResolvable | (IResolvable | QueryParameterProperty)[] (optional)

The query parameter to match on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters