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

HttpApi

Das Objekt, das eine Ereignisquelle mit Typ beschreibt HttpApi.

Wenn eine OpenApi Definition für den angegebenen Pfad und die angegebene Methode in der API vorhanden ist, fügt SAM den Abschnitt Lambda-Integration und -Sicherheit (falls zutreffend) für Sie hinzu.

Wenn in der API keine OpenApi Definition für den angegebenen Pfad und die angegebene Methode vorhanden ist, erstellt SAM diese Definition für Sie.

Syntax

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

Eigenschaften

ApiId

Bezeichner einer in dieser Vorlage definierten AWS::Serverless::HttpApi Ressource.

Falls nicht definiert, wird eine AWS::Serverless::HttpApi Standardressource erstellt, die ServerlessHttpApi mithilfe eines generierten OpenApi Dokuments aufgerufen wird, das eine Vereinigung aller Pfade und Methoden enthält, die durch API-Ereignisse definiert sind, die in dieser Vorlage definiert sind und keine angebenApiId.

Dies kann nicht auf eine AWS::Serverless::HttpApi Ressource verweisen, die in einer anderen Vorlage definiert ist.

Typ: Zeichenfolge

Required: No

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

Auth

Authentifizierungskonfiguration für diese spezielle API+Path+Methode.

Nützlich, um die APIs zu überschreiben DefaultAuthorizer oder die Authentifizierungskonfiguration für einen einzelnen Pfad festzulegen, wenn keine angegeben ist. DefaultAuthorizer

Typ: HttpApiFunctionAuth

Required: No

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

Method

HTTP-Methode, für die diese Funktion aufgerufen wird.

Wenn nein Path und angegeben Method sind, erstellt SAM einen Standard-API-Pfad, der alle Anfragen weiterleitet, die nicht einem anderen Endpunkt dieser Lambda-Funktion zugeordnet sind. Pro API kann nur einer dieser Standardpfade existieren.

Typ: Zeichenfolge

Required: No

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

Path

URI-Pfad, für den diese Funktion aufgerufen wird. Muss mit / beginnen.

Wenn nein Path und angegeben Method sind, erstellt SAM einen Standard-API-Pfad, der alle Anfragen weiterleitet, die nicht einem anderen Endpunkt dieser Lambda-Funktion zugeordnet sind. Pro API kann nur einer dieser Standardpfade existieren.

Typ: Zeichenfolge

Required: No

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

PayloadFormatVersion

Gibt das Format der an eine Integration gesendeten Nutzlast an.

HINWEIS: PayloadFormatVersion erfordert, dass SAM Ihre OpenAPI-Definition ändert, sodass es nur mit Inline funktioniert, die in der DefinitionBody Eigenschaft OpenApi definiert ist.

Typ: Zeichenfolge

Required: No

Standard: 2.0

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

RouteSettings

Die Routeneinstellungen pro Route für diese HTTP-API. Weitere Informationen zu Routeneinstellungen finden Sie AWS::ApiGatewayV2::Stage RouteSettingsim API Gateway Developer Guide.

Hinweis: Wenn sie sowohl in der HttpApi Ressource als auch in der Ereignisquelle angegeben RouteSettings sind, werden sie mit den Eigenschaften der Ereignisquelle AWS SAM zusammengeführt, die Vorrang haben.

Typ: RouteSettings

Required: No

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

TimeoutInMillis

Benutzerdefinierte Zeitüberschreitung zwischen 50 und 29.000 Millisekunden.

HINWEIS: TimeoutInMillis erfordert, dass SAM Ihre OpenAPI-Definition ändert, sodass es nur mit Inline funktioniert, die in der DefinitionBody Eigenschaft OpenApi definiert ist.

Typ: Ganzzahl

Required: No

Standard: 5000

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

Beispiele

HttpApi Standardereignis

HttpApi Ereignis, das den Standardpfad verwendet. Alle nicht zugewiesenen Pfade und Methoden auf dieser API werden zu diesem Endpunkt weitergeleitet.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

HttpApi

HttpApi Ereignis, das einen bestimmten Pfad und eine bestimmte Methode verwendet.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET

HttpApi Autorisierung

HttpApi Ereignis, das einen Authorizer verwendet.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2