RequestModel

特定の API とパスとメソッドのリクエストモデルを設定します。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

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

プロパティ

Model

AWS::Serverless::Api の Models プロパティで定義されたモデルの名前です。

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

Required

指定された API エンドポイントの OpenAPI 定義のパラメータセクションに required プロパティを追加します。

タイプ: ブール

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

ValidateBody

API Gateway が Model を使用してリクエストボディを検証するかどうかを指定します。詳細については、API Gateway デベロッパーガイドのAPI Gateway でリクエストに対する検証を有効にするを参照してください。

タイプ: ブール

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

ValidateParameters

API Gateway が Model を使用してリクエストパスのパラメータ、クエリ文字列、ヘッダーを検証するかどうかを指定します。詳細については、API Gateway デベロッパーガイドのAPI Gateway でリクエストに対する検証を有効にするを参照してください。

タイプ: ブール

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

例

リクエストモデル

リクエストモデルの例

YAML

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