interface LambdaAuthorizerConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnApi.LambdaAuthorizerConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApi_LambdaAuthorizerConfigProperty`
Java	`software.amazon.awscdk.services.appsync.CfnApi.LambdaAuthorizerConfigProperty`
Python	`aws_cdk.aws_appsync.CfnApi.LambdaAuthorizerConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnApi` » `LambdaAuthorizerConfigProperty`

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const lambdaAuthorizerConfigProperty: appsync.CfnApi.LambdaAuthorizerConfigProperty = {
  authorizerUri: 'authorizerUri',

  // the properties below are optional
  authorizerResultTtlInSeconds: 123,
  identityValidationExpression: 'identityValidationExpression',
};

Properties

Name	Type	Description
authorizerUri	`string`	The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
authorizerResultTtlInSeconds?	`number`	The number of seconds a response should be cached for.
identityValidationExpression?	`string`	A regular expression for validation of tokens before the Lambda function is called.

authorizerUri

Type: string

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 AWS Command Line Interface ( AWS 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

authorizerResultTtlInSeconds?

Type: number (optional)

The number of seconds a response should be cached for.

The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

identityValidationExpression?

Type: string (optional)

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