AWS::ApiGateway::RequestValidator - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGateway::RequestValidator

AWS::ApiGateway::RequestValidator 资源为 API 的传入请求设置基本验证规则。有关更多信息,请参阅 API Gateway 开发人员指南中的在 API Gateway 中为 API 启用基本请求验证

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

Name

该请求验证程序的名称。

必需:否

类型:字符串

Update requires: Replacement

RestApiId

目标 API 实体的标识符。

必需:是

类型:字符串

Update requires: Replacement

ValidateRequestBody

指示是否根据目标 API 和方法的配置模式验证请求正文。

必需:否

类型:布尔值

Update requires: No interruption

ValidateRequestParameters

指示是否验证请求参数。

必需:否

类型:布尔值

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回请求验证程序的 ID,例如 abc123

For more information about using the Ref function, see Ref.

示例

创建请求验证程序

以下示例根据提供的参数创建一个具有关联请求验证程序的 API Gateway API。

JSON

{ "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

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

另请参阅