ApiDefinition

Filtrer la vue

All

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::ApiGateway::RestApi S3Location 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::ApiGateway::RestApi S3Location 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::ApiGateway::RestApi S3Location données.

Exemples

Exemple de définition d'Uri

Exemple de définition d'API

YAML

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