RequestModel - AWS Serverless Application Model
SintaxePropriedadesExemplos

RequestModel

Configura um modelo de solicitação para uma API+Path+Method específica.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

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

Propriedades

Model

Nome de um modelo definido na propriedade Models doAWS::Serverless::Api.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Required

Adiciona uma propriedade required na seção de parâmetros da definição de OpenAPI para o determinado endpoint de API.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

ValidateBody

Especifica se o API Gateway usa o Model para validar o corpo da solicitação. Para obter mais informações, consulte Ativar validação de solicitação no API Gateway no Guia do desenvolvedor do API Gateway.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

ValidateParameters

Especifica se o API Gateway usa o Model para validar parâmetros do caminho da solicitação, cadeias de caracteres de consulta e cabeçalhos. Para obter mais informações, consulte Ativar validação de solicitação no API Gateway no Guia do desenvolvedor do API Gateway.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Exemplos

Modelo de solicitação

Exemplo de modelo de solicitação

YAML

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