import { _ParameterConstraints, _UnmarshalledParameterConstraints } from "./_ParameterConstraints"; /** *
Represents a route.
*/ export interface _Route { /** *Specifies whether an API key is required for this route.
*/ ApiKeyRequired?: boolean; /** *A list of authorization scopes configured on a route. The scopes are used with a * COGNITO_USER_POOLS 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.
*/ AuthorizationScopes?: ArrayThe authorization type for the route. Valid values are NONE for open * access, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda * authorizer
*/ AuthorizationType?: "NONE" | "AWS_IAM" | "CUSTOM" | string; /** *The identifier of the Authorizer resource to be associated with this * route, if the authorizationType is CUSTOM * . The authorizer identifier is generated by API Gateway * when you created the authorizer.
*/ AuthorizerId?: string; /** *The model selection expression for the route.
*/ ModelSelectionExpression?: string; /** *The operation name for the route.
*/ OperationName?: string; /** *The request models for the route.
*/ RequestModels?: { [key: string]: string; } | Iterable<[string, string]>; /** *The request parameters for the route.
*/ RequestParameters?: { [key: string]: _ParameterConstraints; } | Iterable<[string, _ParameterConstraints]>; /** *The route ID.
*/ RouteId?: string; /** *The route key for the route.
*/ RouteKey: string; /** *The route response selection expression for the route.
*/ RouteResponseSelectionExpression?: string; /** *The target for the route.
*/ Target?: string; } export interface _UnmarshalledRoute extends _Route { /** *A list of authorization scopes configured on a route. The scopes are used with a * COGNITO_USER_POOLS 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.
*/ AuthorizationScopes?: ArrayThe request models for the route.
*/ RequestModels?: { [key: string]: string; }; /** *The request parameters for the route.
*/ RequestParameters?: { [key: string]: _UnmarshalledParameterConstraints; }; }