Interface CfnGraphQLApi.LambdaAuthorizerConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnGraphQLApi.LambdaAuthorizerConfigProperty.Jsii$Proxy
Enclosing class:
CfnGraphQLApi

@Stability(Stable) public static interface CfnGraphQLApi.LambdaAuthorizerConfigProperty extends software.amazon.jsii.JsiiSerializable
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();
 
  • Method Details

    • getAuthorizerResultTtlInSeconds

      @Stability(Stable) @Nullable default Number getAuthorizerResultTtlInSeconds()
      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.

    • getAuthorizerUri

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getIdentityValidationExpression()
      A regular expression for validation of tokens before the Lambda function is called.
    • builder

      @Stability(Stable) static CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder builder()
      Returns:
      a CfnGraphQLApi.LambdaAuthorizerConfigProperty.Builder of CfnGraphQLApi.LambdaAuthorizerConfigProperty