View a markdown version of this page

WebSocketApiAuth - 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.

WebSocketApiAuth

Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre Amazon API Gateway WebSocket Gateway-API zu kontrollieren.

Weitere Informationen zur Konfiguration des Zugriffs auf WebSocket APIs finden Sie unter Steuern des Zugriffs auf WebSocket APIs im API Gateway Developer Guide.

Syntax

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

YAML

AuthArn: String
AuthType: String
IdentitySource: List
InvokeRole: String
Name: String

Eigenschaften

AuthArn

Der ARN der Lambda-Funktion, die für die Autorisierung verwendet werden soll. Erforderlich, wann AuthType istCUSTOM.

Typ: Zeichenfolge

Required: Conditional

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

AuthType

Die Art der Autorisierung. Gültige Werte sind NONE, AWS_IAM oder CUSTOM.

  • NONE- Keine Autorisierung

  • AWS_IAM- IAM-Autorisierung

  • CUSTOM- Lambda-Autorisierer

Typ: Zeichenfolge

Erforderlich: Ja

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

IdentitySource

Die Identitätsquelle, für die die Autorisierung angefordert wird. Beispiel, route.request.header.Authorization.

Typ: Liste

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die IdentitySource Eigenschaft einer AWS::ApiGatewayV2::Authorizer Ressource übergeben.

InvokeRole

Der ARN der IAM-Rolle, die API Gateway beim Aufrufen der Autorisierungsfunktion annimmt. Wenn nicht angegeben, AWS SAM wird automatisch eine ressourcenbasierte Berechtigung erstellt, die es API Gateway ermöglicht, die Autorisierungsfunktion aufzurufen.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die AuthorizerCredentialsArn Eigenschaft einer Ressource übergeben. AWS::ApiGatewayV2::Authorizer

Name

Der Name des Genehmigers.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Name Eigenschaft einer AWS::ApiGatewayV2::Authorizer Ressource übergeben.

Beispiele

Lambda-Autorisierer

Im folgenden Beispiel wird ein Lambda-Authorizer für eine API konfiguriert. WebSocket 

Auth:
  AuthType: CUSTOM
  AuthArn: !GetAtt AuthorizerFunction.Arn
  IdentitySource:
    - route.request.header.Authorization

IAM-Autorisierung

Im folgenden Beispiel wird die IAM-Autorisierung für eine API konfiguriert. WebSocket 

Auth:
  AuthType: AWS_IAM