CreateRouteRequest

import type { CreateRouteRequest } from "https://aws-api.deno.dev/v0.3/services/apigatewayv2.ts?docs=full";

Creates a new Route resource to represent a route.

interface CreateRouteRequest {

ApiId: string;

ApiKeyRequired?: boolean | null;

AuthorizationScopes?: string[] | null;

AuthorizationType?: AuthorizationType | null;

AuthorizerId?: string | null;

ModelSelectionExpression?: string | null;

OperationName?: string | null;

RequestModels?: {

[key: string]: string | null | undefined;

} | null;

RequestParameters?: {

[key: string]: ParameterConstraints | null | undefined;

} | null;

RouteKey: string;

RouteResponseSelectionExpression?: string | null;

Target?: string | null;

}

§Properties

ApiId: string

[src]

The API identifier.

ApiKeyRequired?: boolean | null

[src]

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

AuthorizationScopes?: string[] | null

[src]

The authorization scopes supported by this route.

AuthorizationType?: AuthorizationType | null

[src]

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 | null

[src]

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 | null

[src]

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

OperationName?: string | null

[src]

The operation name for the route.

RequestModels?: {

[key: string]: string | null | undefined;

} | null

[src]

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

RequestParameters?: {