Package software.amazon.awssdk.services.appsync.model

Class LambdaAuthorizerConfig

java.lang.Object

software.amazon.awssdk.services.appsync.model.LambdaAuthorizerConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LambdaAuthorizerConfig.Builder,LambdaAuthorizerConfig>

@Generated("software.amazon.awssdk:codegen")
public final class LambdaAuthorizerConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LambdaAuthorizerConfig.Builder,LambdaAuthorizerConfig>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LambdaAuthorizerConfig.Builder

Method Summary

Modifier and Type	Method	Description
Integer	authorizerResultTtlInSeconds()	The number of seconds a response should be cached for.
String	authorizerUri()	The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
static LambdaAuthorizerConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityValidationExpression()	A regular expression for validation of tokens before the Lambda function is called.
List<SdkField<?>>	sdkFields()
static Class<? extends LambdaAuthorizerConfig.Builder>	serializableBuilderClass()
LambdaAuthorizerConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authorizerResultTtlInSeconds

public final Integer 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.

Returns:

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.

authorizerUri

public final String 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 Command Line Interface (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

Returns:

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

public final String identityValidationExpression()

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

Returns:

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

toBuilder

public LambdaAuthorizerConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LambdaAuthorizerConfig.Builder,LambdaAuthorizerConfig>

builder

public static LambdaAuthorizerConfig.Builder builder()

serializableBuilderClass

public static Class<? extends LambdaAuthorizerConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo