HttpApiAuth

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

Weitere Informationen zur Konfiguration des Zugriffs auf HTTP-APIs finden Sie unter Steuern und Verwalten des Zugriffs auf eine HTTP-API in API Gateway 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

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

Eigenschaften

Authorizers

Der Autorisierer, der zur Steuerung des Zugriffs auf Ihre API-Gateway-API verwendet wird.

Typ: OAuth2Authorizer | LambdaAuthorizer

Required: No

Standard: Keiner

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

Zusätzliche Hinweise: AWS SAM Fügt die Autorisierer zur OpenAPI-Definition hinzu.

DefaultAuthorizer

Geben Sie den Standard-Authorizer an, der für die Autorisierung von API-Aufrufen an Ihre API-Gateway-API verwendet werden soll. Sie können ihn AWS_IAM als Standardautorisierer angeben, wenn er auf gesetzt EnableIamAuthorizer ist. true Geben Sie andernfalls einen Autorisierer an, den Sie in definiert haben. Authorizers

Typ: Zeichenfolge

Required: No

Standard: Keiner

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

EnableIamAuthorizer

Geben Sie an, ob die IAM-Autorisierung für die API-Route verwendet werden soll.

Typ: Boolesch

Required: No

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

Beispiele

OAuth 2.0-Autorisierer

Beispiel für einen OAuth 2.0-Authorizer

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

IAM-Autorisierer

Beispiel für einen IAM-Autorisierer

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM