HttpApiFunctionAuth - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

HttpApiFunctionAuth

Konfiguriert die Autorisierung auf Veranstaltungsebene.

Konfigurieren Sie Auth für eine bestimmte API + Path + Methode

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

YAML

  AuthorizationScopes: List
  Authorizer: String

Eigenschaften

AuthorizationScopes

Die Autorisierungsbereiche, die für diese API, diesen Pfad und diese Methode gelten sollen.

Die hier aufgelisteten Bereiche setzen alle Bereiche außer Kraft, die von angewendet werden, DefaultAuthorizer falls vorhanden.

Typ: Liste

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

Authorizer

Die Authorizer für eine bestimmte Funktion. Um die IAM-Autorisierung zu verwenden, geben Sie EnableIamAuthorizer im Globals Abschnitt Ihrer Vorlage die Angabe AWS_IAM und Spezifizierung true für an.

Wenn Sie in der API einen Global Authorizer angegeben haben und eine bestimmte Funktion öffentlich machen möchten, überschreiben Sie dies, indem Sie auf setzenAuthorizer. NONE

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

Beispiele

Funktions-Auth

Autorisierung auf Funktionsebene angeben

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

IAM-Autorisierung

Spezifiziert die IAM-Autorisierung auf Ereignisebene. Um die AWS_IAM Autorisierung auf Veranstaltungsebene zu verwenden, müssen Sie EnableIamAuthorizer im Globals Abschnitt Ihrer Vorlage auch true for angeben. Weitere Informationen finden Sie unter Abschnitt „Globals“ der Vorlage 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