interface CfnRouteMixinProps

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

Properties for CfnRoutePropsMixin.

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 { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';

declare const requestModels: any;
declare const requestParameters: any;
const cfnRouteMixinProps: apigatewayv2_mixins.CfnRouteMixinProps = {
  apiId: 'apiId',
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  modelSelectionExpression: 'modelSelectionExpression',
  operationName: 'operationName',
  requestModels: requestModels,
  requestParameters: requestParameters,
  routeKey: 'routeKey',
  routeResponseSelectionExpression: 'routeResponseSelectionExpression',
  target: 'target',
};

Properties

Name	Type	Description
apiId?	`string`	The API identifier.
apiKeyRequired?	`boolean \|` `IResolvable`	Specifies whether an API key is required for the route.
authorizationScopes?	`string[]`	The authorization scopes supported by this route.
authorizationType?	`string`	The authorization type for the route.
authorizerId?	`string`	The identifier of the `Authorizer` resource to be associated with this route.
modelSelectionExpression?	`string`	The model selection expression for the route.
operationName?	`string`	The operation name for the route.
requestModels?	`any`	The request models for the route.
requestParameters?	`any`	The request parameters for the route.
routeKey?	`string`	The route key for the route.
routeResponseSelectionExpression?	`string`	The route response selection expression for the route.
target?	`string`	The target for the route.

apiId?

Type: string (optional)

The API identifier.

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

apiKeyRequired?

Type: boolean | IResolvable (optional)

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

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

authorizationScopes?

Type: string[] (optional)

The authorization scopes supported by this route.

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

authorizationType?

Type: string (optional)

The authorization type for the route.

For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

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