AWS::AppSync::Api LambdaAuthorizerConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AppSync::Api LambdaAuthorizerConfig

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AuthorizerResultTtlInSeconds" : Integer,
  "AuthorizerUri" : String,
  "IdentityValidationExpression" : String
}

Properties

AuthorizerResultTtlInSeconds

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.

Required: No

Type: Integer

Minimum: 0

Maximum: 3600

Update requires: No interruption

AuthorizerUri

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

Required: Yes

Type: String

Update requires: No interruption

IdentityValidationExpression

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

Required: No

Type: String

Update requires: No interruption