Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateRouteCommandInput

Hierarchy

Index

Properties

ApiId

ApiId: string | undefined

The API identifier.

Optional ApiKeyRequired

ApiKeyRequired: undefined | false | true

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

Optional AuthorizationScopes

AuthorizationScopes: string[]

The authorization scopes supported by this route.

Optional AuthorizationType

AuthorizationType: 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.

Optional AuthorizerId

AuthorizerId: undefined | 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.

Optional ModelSelectionExpression

ModelSelectionExpression: undefined | string

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

Optional OperationName

OperationName: undefined | string

The operation name for the route.

Optional RequestModels

RequestModels: Record<string, string>

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

Optional RequestParameters

RequestParameters: Record<string, ParameterConstraints>

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

RouteKey

RouteKey: string | undefined

The route key for the route.

Optional RouteResponseSelectionExpression

RouteResponseSelectionExpression: undefined | string

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

Optional Target

Target: undefined | string

The target for the route.