AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::RequestValidator

ApiGateway RequestValidator

The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
RestApiId
string
RequiredCreate-only
Name
string
Create-only
ValidateRequestBody
boolean
ValidateRequestParameters
boolean

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
RequestValidatorIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::RequestValidator

Resources:
  MyResource:
    Type: AWS::ApiGateway::RequestValidator
    Properties:
      RestApiId: "my-restapiid"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GET

update

apigateway:PATCHapigateway:GET

delete

apigateway:DELETE

read

apigateway:GET

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties5
Required1
TaggingNot supported
Primary IDRestApiId

Supported Operations

CreateUpdateDeleteReadList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameRestApiId

Related Resources

External Links