HttpApiFunctionAuth - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

HttpApiFunctionAuth

Configure l'autorisation au niveau de l'événement.

Configurez l'autorisation pour une formule Api+Chemin+Méthode spécifique.

Syntaxe

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

YAML

  AuthorizationScopes: List
  Authorizer: String

Propriétés

AuthorizationScopes

Les étendues d'autorisation à appliquer à cette API, ce chemin d'accès et cette méthode.

Les portées répertoriées ici remplaceront toutes les portées appliquées par le DefaultAuthorizer s'il en existe un.

Type : liste

Obligatoire : non

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

Authorizer

Le Authorizer pour une Fonction spécifique. Pour utiliser l'autorisation IAM, spécifiez AWS_IAM et spécifiez true pour EnableIamAuthorizer dans la section Globals de votre modèle.

Si vous avez spécifié un mécanisme d'autorisation global sur l'API et que vous souhaitez rendre publique une fonction spécifique, remplacez en définissant Authorizer sur NONE.

Type : chaîne

Obligatoire : non

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

Exemples

Fonction-Auth (Autorisation fonction)

Spécification de l'autorisation au niveau de la fonction

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

autorisation IAM

Spécifie l'autorisation IAM au niveau de l'événement. Pour utiliser l'autorisation AWS_IAM au niveau de l'événement, vous devez également spécifier true pour EnableIamAuthorizer dans la section Globals de votre modèle. Pour de plus amples informations, veuillez consulter Section Globals du modèle 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