AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::RequestValidator

AWS::ApiGateway::RequestValidator 资源为传入 API 网关 API 的请求设置基本验证规则。有关更多信息,请参阅 API 网关 开发人员指南 中的在 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

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回请求验证程序的 ID,如 abc123

有关使用 Ref 功能的更多信息,请参阅参考

示例

以下示例根据提供的参数创建一个具有关联请求验证程序的 API 网关 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

本页内容: