メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ApiGateway::RequestValidator

AWS::ApiGateway::RequestValidator リソースで、API Gateway API への受信リクエストに対する基本的な検証ルールを設定します。詳細については、『API Gateway 開発者ガイド』の「API Gateway で API へのリクエストに対する基本的な検証を有効にする」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::ApiGateway::RequestValidator", "Properties" : { "Name" : String, "RestApiId" : String, "ValidateRequestBody" : Boolean, "ValidateRequestParameters" : Boolean } }

YAML

Copy
Type: "AWS::ApiGateway::RequestValidator" Properties: Name: String RestApiId: String ValidateRequestBody: Boolean ValidateRequestParameters: Boolean

プロパティ

注記

各プロパティの詳細については、『Amazon API Gateway REST API リファレンス』の「RequestValidator」を参照してください。

Name

このリクエスト検証元の名前。

Required: Yes

Type: String

更新に伴う要件: 置換

RestApiId

ターゲット API エンティティの識別子。

Required: Yes

Type: String

更新に伴う要件: 置換

ValidateRequestBody

ターゲットの API とメソッドの設定済みスキーマに従ってリクエスト本体を検証するかどうかを示します。

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

ValidateRequestParameters

リクエストパラメータを検証するかどうかを示します。

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID を Ref 組み込み関数に渡すと、Ref はリクエスト検証元の ID ( abc123 など) を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

以下の例では、指定したパラメータに基づいて、リクエスト検証元を関連付けて、API Gateway API を作成しています。

JSON

Copy
{ "Parameters": { "apiName": { "Type": "String" }, "validatorName": { "Type": "String" }, "validateRequestBody": { "Type": "String" }, "validateRequestParameters": { "Type": "String" } }, "Resources": { "RestApi": { "Type": "AWS::ApiGateway::RestApi", "Properties": { "Name": { "Ref": "apiName" } } }, "RequestValidator": { "Type": "AWS::ApiGateway::RequestValidator", "Properties": { "Name": { "Ref": "validatorName" }, "RestApiId": { "Ref": "RestApi" }, "ValidateRequestBody": { "Ref": "validateRequestBody" }, "ValidateRequestParameters": { "Ref": "validateRequestParameters" } } } } }

YAML

Copy
Parameters: apiName: Type: String validatorName: Type: String validateRequestBody: Type: String validateRequestParameters: Type: String Resources: RestApi: Type: 'AWS::ApiGateway::RestApi' Properties: Name: !Ref apiName RequestValidator: Type: 'AWS::ApiGateway::RequestValidator' Properties: Name: !Ref validatorName RestApiId: !Ref RestApi ValidateRequestBody: !Ref validateRequestBody ValidateRequestParameters: !Ref validateRequestParameters

このページの内容: