interface CfnRoutingRuleMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnRoutingRuleMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnRoutingRuleMixinProps
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnRoutingRuleMixinProps
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnRoutingRuleMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnRoutingRuleMixinProps

Properties for CfnRoutingRulePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
const cfnRoutingRuleMixinProps: apigatewayv2_mixins.CfnRoutingRuleMixinProps = {
  actions: [{
    invokeApi: {
      apiId: 'apiId',
      stage: 'stage',
      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)[] (optional)

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-actions

---

conditions?

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

The conditions of the routing rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-conditions

---

domainNameArn?

Type: string (optional)

The ARN of the domain name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-domainnamearn

---

priority?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html#cfn-apigatewayv2-routingrule-priority