ApiDefinition - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

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

Un documento de OpenAPI que define la API.

Sintaxis

Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

  Bucket: String
  Key: String
  Version: String

Propiedades

Bucket

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

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Bucket del tipo de datos AWS::ApiGateway::RestApi S3Location.

Key

La clave de Amazon S3 del archivo de OpenAPI.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Key del tipo de datos AWS::ApiGateway::RestApi S3Location.

Version

Para objetos con control de versiones, la versión del archivo de OpenAPI.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Version del tipo de datos AWS::ApiGateway::RestApi S3Location.

Ejemplos

Ejemplo de definición de Uri

Ejemplo de definición de API

YAML

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