Interface CfnApi.ILambdaAuthorizerConfigProperty
A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnApi.ILambdaAuthorizerConfigPropertySyntax (vb)
Public Interface CfnApi.ILambdaAuthorizerConfigPropertyRemarks
Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var lambdaAuthorizerConfigProperty = new LambdaAuthorizerConfigProperty {
AuthorizerUri = "authorizerUri",
// the properties below are optional
AuthorizerResultTtlInSeconds = 123,
IdentityValidationExpression = "identityValidationExpression"
};Synopsis
Properties
| AuthorizerResultTtlInSeconds | The number of seconds a response should be cached for. |
| AuthorizerUri | The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. |
| IdentityValidationExpression | A regular expression for validation of tokens before the Lambda function is called. |
Properties
AuthorizerResultTtlInSeconds
The number of seconds a response should be cached for.
double? AuthorizerResultTtlInSeconds { get; }Property Value
Remarks
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.
AuthorizerUri
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
string AuthorizerUri { get; }Property Value
Remarks
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
IdentityValidationExpression
A regular expression for validation of tokens before the Lambda function is called.
string? IdentityValidationExpression { get; }