Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateRouteRequest

Creates a new Route resource to represent a route.

Hierarchy

Properties

ApiId: undefined | string

The API identifier.

ApiKeyRequired?: boolean

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

AuthorizationScopes?: string[]

The authorization scopes supported by this route.

AuthorizationType?: string

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.

AuthorizerId?: string

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

ModelSelectionExpression?: string

The model selection expression for the route. Supported only for WebSocket APIs.

OperationName?: string

The operation name for the route.

RequestModels?: Record<string, string>

The request models for the route. Supported only for WebSocket APIs.

RequestParameters?: Record<string, ParameterConstraints>

The request parameters for the route. Supported only for WebSocket APIs.

RouteKey: undefined | string

The route key for the route.

RouteResponseSelectionExpression?: string

The route response selection expression for the route. Supported only for WebSocket APIs.

Target?: string

The target for the route.