RequestModel - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

RequestModel

Configura un modelo de solicitud para una API+ruta+método específicos.

Sintaxis

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

YAML

  Model: String
  Required: Boolean
  ValidateBody: Boolean
  ValidateParameters: Boolean

Propiedades

Model

Nombre de un modelo definido en la propiedad Modelos del AWS::Serverless::Api.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

Required

Añade una propiedad required en la sección de parámetros de la definición de OpenAPI para el punto de conexión de la API determinado.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

ValidateBody

Especifica si API Gateway utiliza el Model para validar el cuerpo de la solicitud. Para obtener más información, consulta Habilitar la validación de solicitudes en API Gateway en la Guía para desarrolladores de API Gateway.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

ValidateParameters

Especifica si API Gateway utiliza el Model para validar los parámetros de la ruta de solicitud, las cadenas de consulta y los encabezados. Para obtener más información, consulta Habilitar la validación de solicitudes en API Gateway en la Guía para desarrolladores de API Gateway.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

Ejemplos

Modelo de solicitud

Ejemplo de modelo de solicitud

YAML

RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true