LambdaTokenAuthorizer

Filtrer la vue

All

Configurez un mécanisme d'autorisation Lambda pour contrôler l'accès à votre API à l'aide d'une fonction Lambda.

Pour plus d’informations et d’exemples, consultez Contrôlez l'accès aux API avec votre AWS SAM modèle.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

DisableFunctionDefaultPermissions: Boolean
FunctionArn: String
FunctionInvokeRole: String
FunctionPayloadType: String
Identity: LambdaTokenAuthorizationIdentity

Propriétés

DisableFunctionDefaultPermissions

Spécifiez true pour AWS SAM empêcher la création automatique d'une AWS::Lambda::Permissions ressource afin de fournir des autorisations entre votre AWS::Serverless::Api ressource et la fonction Lambda d'autorisation.

Valeur par défaut : false

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

FunctionArn

Spécifiez la fonction ARN de la fonction Lambda qui fournit l'autorisation pour l'API.

Note

AWS SAM créera automatiquement une AWS::Lambda::Permissions ressource lorsque cela FunctionArn est spécifié pourAWS::Serverless::Api. La ressource AWS::Lambda::Permissions fournit des autorisations entre votre API et la fonction Lambda du mécanisme d'autorisation.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

FunctionInvokeRole

Ajoute les informations d'identification de l'autorisateur à la OpenApi définition de l'autorisateur Lambda.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

FunctionPayloadType

Cette propriété peut être utilisée pour définir le type de mécanisme d'autorisation Lambda pour une Api.

Valeurs valides : TOKEN ou REQUEST

Type : chaîne

Obligatoire : non

Par défaut : TOKEN

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Identity

Cette propriété peut être utilisée pour spécifier une IdentitySource dans une demande d'autorisation entrante. Cette propriété n'est requise que si la propriété FunctionPayloadType est définie sur REQUEST.

Type : LambdaTokenAuthorizationIdentity

Obligatoire : Conditionnelle

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

LambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300

BasicLambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn