aws-cdk-lib.aws_apigateway.CfnRequestValidatorProps

interface CfnRequestValidatorProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnRequestValidatorProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnRequestValidatorProps
Javasoftware.amazon.awscdk.services.apigateway.CfnRequestValidatorProps
Pythonaws_cdk.aws_apigateway.CfnRequestValidatorProps
TypeScript aws-cdk-lib » aws_apigateway » CfnRequestValidatorProps

Properties for defining a CfnRequestValidator.

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

NameTypeDescription
restApiIdstringThe string identifier of the associated RestApi.
name?stringThe name of this RequestValidator.
validateRequestBody?boolean | IResolvableA Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validateRequestParameters?boolean | IResolvableA Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

restApiId

Type: string

The string identifier of the associated RestApi.


name?

Type: string (optional)

The name of this RequestValidator.


validateRequestBody?

Type: boolean | IResolvable (optional)

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


validateRequestParameters?

Type: boolean | IResolvable (optional)

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