Interface BaseRoute

interface BaseRoute {
    apiKeyRequired?: boolean;
    authorizers?: Authorizer | Authorizer[];
    iamAuthEnabled?: boolean;
    requestValidator?: RequestValidator;
    requiredParameters?: Parameter[];
}

Hierarchy (view full)

Properties

apiKeyRequired? authorizers? iamAuthEnabled? requestValidator? requiredParameters?

Properties

Optional apiKeyRequired

apiKeyRequired?: boolean

If true, an API key will be required for this route. The source for the API Key can be set at the API level and by default, the source will be the HEADER.

Optional authorizers

authorizers?: Authorizer | Authorizer[]

Authorizers allows you to define Lambda authorizers be applied for authorization when the the route is called.

Optional iamAuthEnabled

iamAuthEnabled?: boolean

By default, the route method auth type is set to NONE. If true, the auth type will be set to AWS_IAM.

Optional requestValidator

requestValidator?: RequestValidator

Request Validator specifies the validator to use at the method level. This will override anything defined at the API level.

Optional requiredParameters

requiredParameters?: Parameter[]

Required Parameters to validate. If the request validator is set to ALL or PARAMS_ONLY, api gateway will validate these before sending traffic to the event handler.

Settings

Member Visibility

Theme

On This Page

apiKeyRequiredauthorizersiamAuthEnabledrequestValidatorrequiredParameters

Generated using TypeDoc