RequestParameter - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

RequestParameter

特定の Api とパスとメソッドのリクエストパラメータを設定します。

リクエストパラメータには、Required または Caching プロパティを指定する必要があります

構文

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

YAML

  Caching: Boolean
  Required: Boolean

プロパティ

Caching

API Gateway OpenApi 定義に cacheKeyParameters セクションを追加します。

タイプ: ブール

必須: 条件に応じて異なります

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

Required

このフィールドは、パラメータが必須かどうかを指定します。

タイプ: ブール

必須: 条件に応じて異なります

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

例

リクエストパラメータ

リクエストパラメータの設定例

YAML

RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true