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

Api

Das Objekt, das einen Api Ereignisquellentyp beschreibt. Wenn eine AWS::Serverless::Api Ressource definiert ist, müssen der Pfad und die Methodenwerte einer Operation in der OpenAPI-Definition der API entsprechen.

Syntax

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

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

Eigenschaften

Auth

Die Autorisierungskonfiguration für diese API, diesen Pfad und diese Methode.

Verwenden Sie diese Eigenschaft, um die DefaultAuthorizer API-Einstellung für einen einzelnen Pfad zu überschreiben, wenn kein Pfad angegeben DefaultAuthorizer ist, oder um die ApiKeyRequired Standardeinstellung zu überschreiben.

Typ: ApiStateMachineAuth

Required: No

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

Method

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

Typ: Zeichenfolge

Erforderlich: Ja

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

Path

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

Typ: Zeichenfolge

Erforderlich: Ja

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

RestApiId

Der Bezeichner einer RestApi Ressource, die eine Operation mit dem angegebenen Pfad und der angegebenen Methode enthalten muss. In der Regel ist dies so eingestellt, dass es auf eine AWS::Serverless::Api Ressource verweist, die in dieser Vorlage definiert ist.

Wenn Sie diese Eigenschaft nicht definieren, AWS SAM wird mithilfe eines generierten OpenApi Dokuments eine AWS::Serverless::Api Standardressource erstellt. Diese Ressource enthält eine Vereinigung aller Pfade und Methoden, die durch Api Ereignisse in derselben Vorlage definiert wurden, ohne dass a angegeben istRestApiId.

Diese Eigenschaft kann nicht auf eine AWS::Serverless::Api Ressource verweisen, die in einer anderen Vorlage definiert ist.

Typ: Zeichenfolge

Required: No

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

UnescapeMappingTemplate

Macht einfache Anführungszeichen rückgängig, indem sie \' bei der Eingabe', die an die Zustandsmaschine übergeben wird, durch ersetzt werden. Wird verwendet, wenn Ihre Eingabe einfache Anführungszeichen enthält.

Anmerkung

Wenn dieser Wert auf gesetzt ist False und Ihre Eingabe einfache Anführungszeichen enthält, tritt ein Fehler auf.

Typ: Boolesch

Required: No

Standard: False

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

Beispiele

ApiEvent

Das Folgende ist ein Beispiel für ein Ereignis dieses Api Typs.

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get