Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LambdaAuthorizerConfig

A LambdaAuthorizerConfig specifies how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

Hierarchy

  • LambdaAuthorizerConfig

Index

Properties

Optional authorizerResultTtlInSeconds

authorizerResultTtlInSeconds: undefined | number

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

authorizerUri

authorizerUri: string | undefined

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

Optional identityValidationExpression

identityValidationExpression: undefined | string

A regular expression for validation of tokens before the Lambda function is called.