aws-cdk-lib.aws_appmesh.CfnGatewayRoute.HttpGatewayRouteProperty

interface HttpGatewayRouteProperty

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.CfnGatewayRoute.HttpGatewayRouteProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnGatewayRoute_HttpGatewayRouteProperty
Javasoftware.amazon.awscdk.services.appmesh.CfnGatewayRoute.HttpGatewayRouteProperty
Pythonaws_cdk.aws_appmesh.CfnGatewayRoute.HttpGatewayRouteProperty
TypeScript aws-cdk-lib » aws_appmesh » CfnGatewayRoute » HttpGatewayRouteProperty

An object that represents an HTTP gateway route.

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 httpGatewayRouteProperty: appmesh.CfnGatewayRoute.HttpGatewayRouteProperty = {
  action: {
    target: {
      virtualService: {
        virtualServiceName: 'virtualServiceName',
      },

      // the properties below are optional
      port: 123,
    },

    // the properties below are optional
    rewrite: {
      hostname: {
        defaultTargetHostname: 'defaultTargetHostname',
      },
      path: {
        exact: 'exact',
      },
      prefix: {
        defaultPrefix: 'defaultPrefix',
        value: 'value',
      },
    },
  },
  match: {
    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

NameTypeDescription
actionIResolvable | HttpGatewayRouteActionPropertyAn object that represents the action to take if a match is determined.
matchIResolvable | HttpGatewayRouteMatchPropertyAn object that represents the criteria for determining a request match.

action

Type: IResolvable | HttpGatewayRouteActionProperty

An object that represents the action to take if a match is determined.


match

Type: IResolvable | HttpGatewayRouteMatchProperty

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