Interface TokenAuthorizerArgs

The set of arguments for constructing a token LambdaAuthorizer resource.

interface TokenAuthorizerArgs {
    authorizerName?: string;
    authorizerResultTtlInSeconds?: number;
    handler: any;
    header?: string;
    identityValidationExpression?: string;
}

Properties

authorizerName? authorizerResultTtlInSeconds? handler header? identityValidationExpression?

Properties

Optional authorizerName

authorizerName?: string

The name for the Authorizer to be referenced as. This must be unique for each unique authorizer within the API. If no name if specified, a name will be generated for you.

Optional authorizerResultTtlInSeconds

authorizerResultTtlInSeconds?: number

The number of seconds during which the resulting IAM policy is cached. Default is 300s. You can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an authorizer across more than one route you will want to disable the cache or else it will cause problems for you.

handler

handler: any

The authorizerHandler specifies information about the authorizing Lambda. You can either set up the Lambda separately and just provide the required information or you can define the Lambda inline using a JavaScript function.

Optional header

header?: string

The request header for the authorization token. If not set, this defaults to Authorization.

Optional identityValidationExpression

identityValidationExpression?: string

A regular expression for validating the token as the incoming identity. Example: "^x-[a-z]+"

Settings

Member Visibility

Theme

On This Page

authorizerNameauthorizerResultTtlInSecondshandlerheaderidentityValidationExpression

Generated using TypeDoc