interface CfnRequestValidatorProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnRequestValidatorProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnRequestValidatorProps
Java	software.amazon.awscdk.services.apigateway.CfnRequestValidatorProps
Python	aws_cdk.aws_apigateway.CfnRequestValidatorProps
TypeScript	aws-cdk-lib » aws_apigateway » CfnRequestValidatorProps

Properties for defining a CfnRequestValidator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnRequestValidatorProps: apigateway.CfnRequestValidatorProps = {
  restApiId: 'restApiId',

  // the properties below are optional
  name: 'name',
  validateRequestBody: false,
  validateRequestParameters: false,
};

Properties

Name	Type	Description
restApiId	string | IRestApiRef	The string identifier of the associated RestApi.
name?	string	The name of this RequestValidator.
validateRequestBody?	boolean | IResolvable	A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validateRequestParameters?	boolean | IResolvable	A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

---

restApiId

Type: string | IRestApiRef

The string identifier of the associated RestApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid

---

name?

Type: string (optional)

The name of this RequestValidator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name

---

validateRequestBody?

Type: boolean | IResolvable (optional)

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody

---

validateRequestParameters?

Type: boolean | IResolvable (optional)

A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters