ApiDefinition - AWS Serverless Application Model
SintaxisPropertiesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ApiDefinition

Documento de OpenAPI que define la API.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  Bucket: String
  Key: String
  Version: String

Properties

Bucket

El nombre del bucket de Amazon S3 donde se almacena el archivo OpenAPI.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alBucketpropiedad delAWS::ApiGateway::RestApi S3LocationTipos de datos de.

Key

La clave de Amazon S3 del archivo OpenAPI.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alKeypropiedad delAWS::ApiGateway::RestApi S3LocationTipos de datos de.

Version

En el caso de los objetos con control de versiones, se trata de la versión del archivo OpenAPI.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alVersionpropiedad delAWS::ApiGateway::RestApi S3LocationTipos de datos de.

Ejemplos

Ejemplos de definición de Uri

Ejemplos de definición de API

YAML

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