interface CfnRoutingRuleProps

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.CfnRoutingRuleProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnRoutingRuleProps`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnRoutingRuleProps`
Python	`aws_cdk.aws_apigatewayv2.CfnRoutingRuleProps`
TypeScript	`aws-cdk-lib` » `aws_apigatewayv2` » `CfnRoutingRuleProps`

Properties for defining a CfnRoutingRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const cfnRoutingRuleProps: apigatewayv2.CfnRoutingRuleProps = {
  actions: [{
    invokeApi: {
      apiId: 'apiId',
      stage: 'stage',

      // the properties below are optional
      stripBasePath: false,
    },
  }],
  conditions: [{
    matchBasePaths: {
      anyOf: ['anyOf'],
    },
    matchHeaders: {
      anyOf: [{
        header: 'header',
        valueGlob: 'valueGlob',
      }],
    },
  }],
  domainNameArn: 'domainNameArn',
  priority: 123,
};

Properties

Name	Type	Description
actions	`IResolvable` `\|` `IResolvable` `\|` `ActionProperty[]`	The resulting action based on matching a routing rules condition.
conditions	`IResolvable` `\|` `IResolvable` `\|` `ConditionProperty[]`	The conditions of the routing rule.
domainNameArn	`string`	The ARN of the domain name.
priority	`number`	The order in which API Gateway evaluates a rule.

actions

Type: IResolvable | IResolvable | ActionProperty[]

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

conditions

Type: IResolvable | IResolvable | ConditionProperty[]

The conditions of the routing rule.

domainNameArn

Type: string

The ARN of the domain name.

priority

Type: number

The order in which API Gateway evaluates a rule.

Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.