interface CfnRouteV2Props ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnRouteV2Props
Java	software.amazon.awscdk.services.apigateway.CfnRouteV2Props
Python	aws_cdk.aws_apigateway.CfnRouteV2Props
TypeScript (source)	@aws-cdk/aws-apigateway » CfnRouteV2Props

⚠️ Deprecated: moved to package aws-apigatewayv2

Properties for defining a AWS::ApiGatewayV2::Route.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';

declare const requestModels: any;
declare const requestParameters: any;
const cfnRouteV2Props: apigateway.CfnRouteV2Props = {
  apiId: 'apiId',
  routeKey: 'routeKey',

  // the properties below are optional
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  modelSelectionExpression: 'modelSelectionExpression',
  operationName: 'operationName',
  requestModels: requestModels,
  requestParameters: requestParameters,
  routeResponseSelectionExpression: 'routeResponseSelectionExpression',
  target: 'target',
};

Properties

Name	Type	Description
apiId⚠️	string	AWS::ApiGatewayV2::Route.ApiId.
routeKey⚠️	string	AWS::ApiGatewayV2::Route.RouteKey.
apiKeyRequired?⚠️	boolean | IResolvable	AWS::ApiGatewayV2::Route.ApiKeyRequired.
authorizationScopes?⚠️	string[]	AWS::ApiGatewayV2::Route.AuthorizationScopes.
authorizationType?⚠️	string	AWS::ApiGatewayV2::Route.AuthorizationType.
authorizerId?⚠️	string	AWS::ApiGatewayV2::Route.AuthorizerId.
modelSelectionExpression?⚠️	string	AWS::ApiGatewayV2::Route.ModelSelectionExpression.
operationName?⚠️	string	AWS::ApiGatewayV2::Route.OperationName.
requestModels?⚠️	any	AWS::ApiGatewayV2::Route.RequestModels.
requestParameters?⚠️	any	AWS::ApiGatewayV2::Route.RequestParameters.
routeResponseSelectionExpression?⚠️	string	AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.
target?⚠️	string	AWS::ApiGatewayV2::Route.Target.

---

apiId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::Route.ApiId.

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

---

routeKey⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::Route.RouteKey.

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

---

apiKeyRequired?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: boolean | IResolvable (optional)

AWS::ApiGatewayV2::Route.ApiKeyRequired.

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

---

authorizationScopes?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string[] (optional)

AWS::ApiGatewayV2::Route.AuthorizationScopes.

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

---

authorizationType?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.AuthorizationType.

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

---

authorizerId?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.AuthorizerId.

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

---

modelSelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.ModelSelectionExpression.

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

---

operationName?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.OperationName.

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

---

requestModels?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Route.RequestModels.

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

---

requestParameters?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Route.RequestParameters.

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

---

routeResponseSelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression.

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

---

target?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Route.Target.

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