com.amazonaws.services.appsync.model

Class LambdaAuthorizerConfig

java.lang.Object

com.amazonaws.services.appsync.model.LambdaAuthorizerConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LambdaAuthorizerConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LambdaAuthorizerConfig()

Method Summary

Modifier and Type	Method and Description
LambdaAuthorizerConfig	clone()
boolean	equals(Object obj)
Integer	getAuthorizerResultTtlInSeconds() The number of seconds a response should be cached for.
String	getAuthorizerUri() The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
String	getIdentityValidationExpression() A regular expression for validation of tokens before the Lambda function is called.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The number of seconds a response should be cached for.
void	setAuthorizerUri(String authorizerUri) The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
void	setIdentityValidationExpression(String identityValidationExpression) A regular expression for validation of tokens before the Lambda function is called.
String	toString() Returns a string representation of this object.
LambdaAuthorizerConfig	withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds) The number of seconds a response should be cached for.
LambdaAuthorizerConfig	withAuthorizerUri(String authorizerUri) The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
LambdaAuthorizerConfig	withIdentityValidationExpression(String identityValidationExpression) A regular expression for validation of tokens before the Lambda function is called.

Methods inherited from class java.lang.Object

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

Constructor Detail

LambdaAuthorizerConfig

public LambdaAuthorizerConfig()

Method Detail

setAuthorizerResultTtlInSeconds

public void setAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

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.

Parameters:

authorizerResultTtlInSeconds - 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.

getAuthorizerResultTtlInSeconds

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

Returns:

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.

withAuthorizerResultTtlInSeconds

public LambdaAuthorizerConfig withAuthorizerResultTtlInSeconds(Integer authorizerResultTtlInSeconds)

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.

Parameters:

authorizerResultTtlInSeconds - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorizerUri

public void setAuthorizerUri(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

Parameters:

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

getAuthorizerUri

public String getAuthorizerUri()

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

withAuthorizerUri

public LambdaAuthorizerConfig withAuthorizerUri(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIdentityValidationExpression

public void setIdentityValidationExpression(String identityValidationExpression)

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

Parameters:

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

getIdentityValidationExpression

public String getIdentityValidationExpression()

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.

withIdentityValidationExpression

public LambdaAuthorizerConfig withIdentityValidationExpression(String identityValidationExpression)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LambdaAuthorizerConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo