Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Route

Represents a route.

Hierarchy

  • Route

Index

Properties

Optional ApiGatewayManaged

ApiGatewayManaged: undefined | false | true

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

Optional ApiKeyRequired

ApiKeyRequired: undefined | false | true

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

Optional AuthorizationScopes

AuthorizationScopes: string[]

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

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.

Optional RouteId

RouteId: undefined | string

The route ID.

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.