Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Interface CfnRequestValidatorMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRequestValidatorMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.482Z")
@Stability(Stable)
public interface CfnRequestValidatorMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRequestValidatorPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnRequestValidatorMixinProps cfnRequestValidatorMixinProps = CfnRequestValidatorMixinProps.builder()
         .name("name")
         .restApiId("restApiId")
         .validateRequestBody(false)
         .validateRequestParameters(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRequestValidatorMixinProps.Builder	A builder for CfnRequestValidatorMixinProps
static final class	CfnRequestValidatorMixinProps.Jsii$Proxy	An implementation for CfnRequestValidatorMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnRequestValidatorMixinProps.Builder	builder()
default String	getName()	The name of this RequestValidator.
default Object	getRestApiId()	The string identifier of the associated RestApi.
default Object	getValidateRequestBody()	A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
default Object	getValidateRequestParameters()	A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

The name of this RequestValidator.

See Also:

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

getRestApiId

@Stability(Stable)
@Nullable
default Object getRestApiId()

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

See Also:

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

getValidateRequestBody

@Stability(Stable)
@Nullable
default Object getValidateRequestBody()

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

Returns union: either Boolean or IResolvable

See Also:

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

getValidateRequestParameters

@Stability(Stable)
@Nullable
default Object getValidateRequestParameters()

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

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnRequestValidatorMixinProps.Builder builder()

Returns:

a CfnRequestValidatorMixinProps.Builder of CfnRequestValidatorMixinProps