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

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

Overview

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.

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 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:

  • (Integer)


3503
3504
3505
3506
3507
3508
3509
# File 'lib/aws-sdk-appsync/types.rb', line 3503

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

#authorizer_uriString

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:

  • (String)


3503
3504
3505
3506
3507
3508
3509
# File 'lib/aws-sdk-appsync/types.rb', line 3503

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)


3503
3504
3505
3506
3507
3508
3509
# File 'lib/aws-sdk-appsync/types.rb', line 3503

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