Amazonka.AppSync.Types.LambdaAuthorizerConfig

Documentation

data 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: newLambdaAuthorizerConfig smart constructor.

Constructors

LambdaAuthorizerConfig'

Fields

• authorizerResultTtlInSeconds :: Maybe Natural

  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.

• identityValidationExpression :: Maybe Text

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

• authorizerUri :: Text

  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

Instances

FromJSON LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

parseJSON :: Value -> Parser LambdaAuthorizerConfig

parseJSONList :: Value -> Parser [LambdaAuthorizerConfig]

ToJSON LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

toJSON :: LambdaAuthorizerConfig -> Value

toEncoding :: LambdaAuthorizerConfig -> Encoding

toJSONList :: [LambdaAuthorizerConfig] -> Value

toEncodingList :: [LambdaAuthorizerConfig] -> Encoding

Generic LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Associated Types

type Rep LambdaAuthorizerConfig :: Type -> Type

Methods

from :: LambdaAuthorizerConfig -> Rep LambdaAuthorizerConfig x

to :: Rep LambdaAuthorizerConfig x -> LambdaAuthorizerConfig

Read LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

readsPrec :: Int -> ReadS LambdaAuthorizerConfig

readList :: ReadS [LambdaAuthorizerConfig]

readPrec :: ReadPrec LambdaAuthorizerConfig

readListPrec :: ReadPrec [LambdaAuthorizerConfig]

Show LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

showsPrec :: Int -> LambdaAuthorizerConfig -> ShowS

show :: LambdaAuthorizerConfig -> String

showList :: [LambdaAuthorizerConfig] -> ShowS

NFData LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

rnf :: LambdaAuthorizerConfig -> ()

Eq LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

(==) :: LambdaAuthorizerConfig -> LambdaAuthorizerConfig -> Bool

(/=) :: LambdaAuthorizerConfig -> LambdaAuthorizerConfig -> Bool

Hashable LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

Methods

hashWithSalt :: Int -> LambdaAuthorizerConfig -> Int

hash :: LambdaAuthorizerConfig -> Int

type Rep LambdaAuthorizerConfig

Defined in Amazonka.AppSync.Types.LambdaAuthorizerConfig

type Rep LambdaAuthorizerConfig = D1 ('MetaData "LambdaAuthorizerConfig" "Amazonka.AppSync.Types.LambdaAuthorizerConfig" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "LambdaAuthorizerConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newLambdaAuthorizerConfig

Arguments

:: Text

$sel:authorizerUri:LambdaAuthorizerConfig'

-> LambdaAuthorizerConfig

Create a value of LambdaAuthorizerConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorizerResultTtlInSeconds:LambdaAuthorizerConfig', lambdaAuthorizerConfig_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.

$sel:identityValidationExpression:LambdaAuthorizerConfig', lambdaAuthorizerConfig_identityValidationExpression - A regular expression for validation of tokens before the Lambda function is called.

$sel:authorizerUri:LambdaAuthorizerConfig', lambdaAuthorizerConfig_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

lambdaAuthorizerConfig_authorizerResultTtlInSeconds :: Lens' LambdaAuthorizerConfig (Maybe Natural)

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.

lambdaAuthorizerConfig_identityValidationExpression :: Lens' LambdaAuthorizerConfig (Maybe Text)

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

lambdaAuthorizerConfig_authorizerUri :: Lens' LambdaAuthorizerConfig Text

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