Package software.amazon.awscdk.services.apigateway

Interface CfnRequestValidatorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRequestValidatorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:51.565Z")
@Stability(Stable)
public interface CfnRequestValidatorProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigateway.*;
 CfnRequestValidatorProps cfnRequestValidatorProps = CfnRequestValidatorProps.builder()
         .restApiId("restApiId")
         // the properties below are optional
         .name("name")
         .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	CfnRequestValidatorProps.Builder	A builder for CfnRequestValidatorProps
static final class	CfnRequestValidatorProps.Jsii$Proxy	An implementation for CfnRequestValidatorProps

Method Summary

Modifier and Type	Method	Description
static CfnRequestValidatorProps.Builder	builder()
default String	getName()	The name of this RequestValidator.
String	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

getRestApiId

@Stability(Stable)
@NotNull
String getRestApiId()

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

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

getValidateRequestBody

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

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

getValidateRequestParameters

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

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

builder

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

Returns:

a CfnRequestValidatorProps.Builder of CfnRequestValidatorProps