software.amazon.awscdk.services.appsync

Interface CfnGraphQLApi.LambdaAuthorizerConfigProperty

All Known Implementing Classes:

CfnGraphQLApi.LambdaAuthorizerConfigProperty.Jsii$Proxy

Enclosing class:

CfnGraphQLApi

public static interface CfnGraphQLApi.LambdaAuthorizerConfigProperty

Configuration for AWS Lambda function authorization.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 LambdaAuthorizerConfigProperty lambdaAuthorizerConfigProperty = LambdaAuthorizerConfigProperty.builder()
         .authorizerResultTtlInSeconds(123)
         .authorizerUri("authorizerUri")
         .identityValidationExpression("identityValidationExpression")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder A builder for CfnGraphQLApi.LambdaAuthorizerConfigProperty
static class	CfnGraphQLApi.LambdaAuthorizerConfigProperty.Jsii$Proxy An implementation for CfnGraphQLApi.LambdaAuthorizerConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder	builder()
default java.lang.Number	getAuthorizerResultTtlInSeconds() The number of seconds a response should be cached for.
default java.lang.String	getAuthorizerUri() The ARN of the Lambda function to be called for authorization.
default java.lang.String	getIdentityValidationExpression() A regular expression for validation of tokens before the Lambda function is called.

Method Detail

getAuthorizerResultTtlInSeconds

default java.lang.Number getAuthorizerResultTtlInSeconds()

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.

getAuthorizerUri

default java.lang.String getAuthorizerUri()

The ARN of the Lambda function to be called for authorization.

This may be a standard Lambda ARN, a version ARN ( .../v3 ) or 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 do so with the 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

getIdentityValidationExpression

default java.lang.String getIdentityValidationExpression()

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

builder

static CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder builder()

Returns:

a CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder of CfnGraphQLApi.LambdaAuthorizerConfigProperty