software.amazon.awscdk.services.appsync

Interface LambdaAuthorizerConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaAuthorizerConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.859Z")
 @Stability(value=Experimental)
public interface LambdaAuthorizerConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration for Lambda authorization in AppSync.

Note that you can only have a single AWS Lambda function configured to authorize your API.

Example:

 import software.amazon.awscdk.core.*;
 Function authFunction;
 GraphqlApi.Builder.create(this, "api")
         .name("api")
         .schema(Schema.fromAsset(join(__dirname, "appsync.test.graphql")))
         .authorizationConfig(AuthorizationConfig.builder()
                 .defaultAuthorization(AuthorizationMode.builder()
                         .authorizationType(AuthorizationType.LAMBDA)
                         .lambdaAuthorizerConfig(LambdaAuthorizerConfig.builder()
                                 .handler(authFunction)
                                 .build())
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LambdaAuthorizerConfig.Builder	builder()
IFunction	getHandler() (experimental) The authorizer lambda function.
default Duration	getResultsCacheTtl() (experimental) How long the results are cached.
default String	getValidationRegex() (experimental) A regular expression for validation of tokens before the Lambda function is called.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHandler

@Stability(value=Experimental)
 @NotNull
IFunction getHandler()

(experimental) The authorizer lambda function.

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

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html

getResultsCacheTtl

@Stability(value=Experimental)
 @Nullable
default Duration getResultsCacheTtl()

(experimental) How long the results are cached.

Disable caching by setting this to 0.

Default: Duration.minutes(5)

getValidationRegex

@Stability(value=Experimental)
 @Nullable
default String getValidationRegex()

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

Default: - no regex filter will be applied.

builder

@Stability(value=Experimental)
static LambdaAuthorizerConfig.Builder builder()

Returns:

a LambdaAuthorizerConfig.Builder of LambdaAuthorizerConfig