HttpApiFunctionAuth

Configura l'autorizzazione a livello di evento.

Configurazione dell'autenticazione per un metodo API + Path + specifico

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

YAML

  AuthorizationScopes: List
  Authorizer: String

Proprietà

AuthorizationScopes

Gli ambiti di autorizzazione da applicare a questa API, percorso e metodo.

Gli ambiti elencati qui sostituiranno tutti gli ambiti applicati dalDefaultAuthorizerse esiste.

Type: Elenco

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

Authorizer

LaAuthorizerper una funzione specifica. Per utilizzare l'autorizzazione IAM, specificareAWS_IAMe specificaretrueperEnableIamAuthorizernellaGlobalssezione del tuo modello.

Se hai specificato un Global Authorizer sull'API e vuoi rendere pubblica una funzione specifica, sostituisci impostandoAuthorizeraNONE.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

Esempi

Auth Funzione-Auth

Specifica dell'autorizzazione a livello di funzione

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

Autorizzazione IAM

Specifica l'autorizzazione IAM a livello di evento. Per utilizzareAWS_IAMl'autorizzazione a livello di evento, è necessario specificare, tra l'altro, l'trueperEnableIamAuthorizernellaGlobalssezione del tuo modello. Per ulteriori informazioni, consulta la pagina Sezione globale del modello AWS SAM .

YAML

Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9