LambdaTokenAuthorizer

Configura un Lambda Authorizer per controllare l'accesso alla tua API con una funzione Lambda.

Per maggiori informazioni ed esempi, consulta Controllare l'accesso alle API Gateway API.

Sintassi

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

YAML

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

Proprietà

DisableFunctionDefaultPermissions

trueSpecificare per AWS SAM impedire la creazione automatica di una AWS::Lambda::Permissions risorsa per fornire le autorizzazioni tra la AWS::Serverless::Api risorsa e la funzione Lambda dell'autorizzatore.

Valore predefinito: false

Tipo: Booleano

Required: No

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

FunctionArn

Specificare la funzione ARN della funzione Lambda che fornisce l'autorizzazione per l'API.

Nota

AWS SAMcreerà automaticamente una AWS::Lambda::Permissions risorsa quando FunctionArn viene specificato per. AWS::Serverless::Api La AWS::Lambda::Permissions risorsa fornisce le autorizzazioni tra l'API e la funzione Lambda dell'autorizzazione.

Tipo: stringa

Required: Yes

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

FunctionInvokeRole

Aggiunge le credenziali dell'autorizzatore alla OpenApi definizione dell'autorizzatore Lambda.

Tipo: stringa

Required: No

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

FunctionPayloadType

Questa proprietà può essere utilizzata per definire il tipo di Lambda Authorizer per un'Api.

Valori validi: TOKEN o REQUEST

Tipo: stringa

Required: No

Default: TOKEN

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

Identity

Questa proprietà può essere utilizzata per specificare una richiesta IdentitySource in entrata per un autorizzatore. Questa proprietà è richiesta solo se è impostata su. FunctionPayloadType REQUEST

Tipo: LambdaTokenAuthorizationIdentity

Required: Conditional

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

Esempi

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