HttpApiDefinition - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

HttpApiDefinition

Un document OpenAPI définissant l'API.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

  Bucket: String
  Key: String
  Version: String

Propriétés

Bucket

Nom du compartiment Amazon S3 dans lequel le fichier OpenAPI est stocké.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Bucket propriété du type de AWS::ApiGatewayV2::Api BodyS3Location données.

Key

La clé Amazon S3 du fichier OpenAPI.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Key propriété du type de AWS::ApiGatewayV2::Api BodyS3Location données.

Version

Pour les objets versionnés, la version du fichier OpenAPI.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Version propriété du type de AWS::ApiGatewayV2::Api BodyS3Location données.

Exemples

Exemple de définition d'Uri

Exemple de définition d'API

YAML

DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212