Class: Aws::AppSync::Types::LambdaAuthorizerConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Note:

When making an API call, you may pass LambdaAuthorizerConfig data as a hash:

{
  authorizer_result_ttl_in_seconds: 1,
  authorizer_uri: "String", # required
  identity_validation_expression: "String",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_result_ttl_in_secondsInteger

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:

  • (Integer)


2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2098

class LambdaAuthorizerConfig < Struct.new(
  :authorizer_result_ttl_in_seconds,
  :authorizer_uri,
  :identity_validation_expression)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_uriString

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 Amazon Web Services 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:

  • (String)


2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2098

class LambdaAuthorizerConfig < Struct.new(
  :authorizer_result_ttl_in_seconds,
  :authorizer_uri,
  :identity_validation_expression)
  SENSITIVE = []
  include Aws::Structure
end

#identity_validation_expressionString

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

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2098

class LambdaAuthorizerConfig < Struct.new(
  :authorizer_result_ttl_in_seconds,
  :authorizer_uri,
  :identity_validation_expression)
  SENSITIVE = []
  include Aws::Structure
end