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 API documento abierto que define elAPI.

Sintaxis

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

YAML

  Bucket: String
  Key: String
  Version: String

Propiedades

Bucket

El nombre del depósito de Amazon S3 en el que se almacena el API archivo Open.

Tipo: cadena

Obligatorio: sí

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

Key

La clave Amazon S3 del API archivo abierto.

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Key propiedad del tipo de AWS::ApiGateway::RestApi S3Location datos.

Version

En el caso de los objetos versionados, la versión del API archivo Open.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Version propiedad del tipo de AWS::ApiGateway::RestApi S3Location datos.

Ejemplos

Ejemplo de definición de Uri

APIEjemplo de definición

YAML

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