LambdaAuthorizer

Configura un autorizzatore Lambda per controllare l'accesso alla tua API HTTP Amazon API Gateway con una funzione. AWS Lambda

Per ulteriori informazioni ed esempi, consulta Lavorare con AWS Lambda gli autorizzatori per le API HTTP nella Guida per sviluppatori di API Gateway.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

  AuthorizerPayloadFormatVersion: String
  EnableFunctionDefaultPermissions: Boolean
  EnableSimpleResponses: Boolean
  FunctionArn: String
  FunctionInvokeRole: String
  Identity: LambdaAuthorizationIdentity

Proprietà

AuthorizerPayloadFormatVersion

Specifica il formato del payload inviato a un autorizzatore Lambda API HTTP. Richiesto per gli autorizzatori Lambda API HTTP.

Questo viene passato alla authorizerPayloadFormatVersion sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Valori validi: 1.0 o 2.0

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: Questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

EnableFunctionDefaultPermissions

Per impostazione predefinita, alla risorsa API HTTP non viene concessa l'autorizzazione per richiamare l'autorizzatore Lambda. Specificate questa proprietà true per creare automaticamente le autorizzazioni tra la risorsa API HTTP e l'autorizzatore Lambda.

Tipo: Booleano

Required: No

Valore predefinito: false

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un equivalente. AWS CloudFormation

EnableSimpleResponses

Specifica se un autorizzatore Lambda restituisce una risposta in un formato semplice. Per impostazione predefinita, un autorizzatore Lambda deve restituire una policy AWS Identity and Access Management (IAM). Se abilitato, l'autorizzatore Lambda può restituire un valore booleano invece di una policy IAM.

Questo viene passato alla enableSimpleResponses sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Tipo: Booleano

Required: No

AWS CloudFormationcompatibilità: Questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

FunctionArn

L'Amazon Resource Name (ARN) della funzione Lambda che fornisce l'autorizzazione per l'API.

Questo viene passato alla authorizerUri sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: Questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

FunctionInvokeRole

L'ARN del ruolo IAM che dispone delle credenziali necessarie affinché API Gateway richiami la funzione di autorizzazione. Specificate questo parametro se la policy basata sulle risorse della funzione non concede l'autorizzazione API Gateway. lambda:InvokeFunction

Questo viene passato alla authorizerCredentials sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Per ulteriori informazioni, consulta Create a Lambda authorizer nella API Gateway Developer Guide.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Identity

Speciifica un elemento IdentitySource in una richiesta in entrata per un autorizzatore.

Questo viene passato alla identitySource sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Tipo: LambdaAuthorizationIdentity

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Esempi

LambdaAuthorizer

LambdaAuthorizer esempio

YAML

Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization