Function authorizerResponse

  • authorizerResponse(principalId, effect, resource, context?, apiKey?): AuthorizerResponse

  • Simplifies creating an AuthorizerResponse.

    Parameters

    • principalId: string

      unique identifier for the user

    • effect: Effect

      whether to "Allow" or "Deny" the request

    • resource: string

      the API method to be invoked (typically event.methodArn)

    • Optional context: any

      key-value pairs that are passed from the authorizer to the backend Lambda

    • Optional apiKey: string

      if the API uses a usage plan, this must be set to one of the usage plan's API keys

    Returns AuthorizerResponse

Settings

Member Visibility

Theme

Generated using TypeDoc