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

ApiDefinition

Ein OpenAPI-Dokument, das die API definiert.

Syntax

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

YAML

  Bucket: String
  Key: String
  Version: String

Eigenschaften

Bucket

Der Name des Amazon S3-Buckets, in dem die OpenAPI-Datei gespeichert ist.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Bucket Eigenschaft des AWS::ApiGateway::RestApi S3Location Datentyps übergeben.

Key

Der Amazon S3-Schlüssel der OpenAPI-Datei.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Key Eigenschaft des AWS::ApiGateway::RestApi S3Location Datentyps übergeben.

Version

Bei versionierten Objekten die Version der OpenAPI-Datei.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -VersionEigenschaft des -AWS::ApiGateway::RestApiS3LocationDatentyps übergeben.

Beispiele

Beispiel für eine Definitions-URI

Beispiel für eine API-Definition

YAML

DefinitionUri:
  Bucket: mybucket-name
  Key: mykey-name
  Version: 121212