HttpApiFunctionAuth

Configura l'autorizzazione a livello di evento.

Configura l'autenticazione per un metodo API + Path + specifico

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa 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 da, se ne esiste uno. DefaultAuthorizer

Tipo: Elenco

Required: No

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

Authorizer

Il Authorizer per una funzione specifica. Per utilizzare l'autorizzazione IAM, specifica AWS_IAM e specifica true for EnableIamAuthorizer nella Globals sezione del modello.

Se hai specificato un Global Authorizer sull'API e desideri rendere pubblica una funzione specifica, esegui l'override Authorizer impostando su. NONE

Tipo: stringa

Required: No

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

Esempi

Autenticazione della funzione

Specificazione dell'autorizzazione a livello di funzione

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

Autorizzazione IAM

Specifica l'autorizzazione IAM a livello di evento. Per utilizzare AWS_IAM l'autorizzazione a livello di evento, è inoltre necessario specificare true for EnableIamAuthorizer nella Globals sezione del modello. Per ulteriori informazioni, consulta Sezione Globals 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