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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.129Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRequestValidatorProps.Builder	builder()
default String	getName() The name of this request validator.
String	getRestApiId() The identifier of the targeted API entity.
default Object	getValidateRequestBody() Indicates whether to validate the request body according to the configured schema for the targeted API and method.
default Object	getValidateRequestParameters() Indicates whether to validate request parameters.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

The identifier of the targeted API entity.

getName

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

The name of this request validator.

getValidateRequestBody

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

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

getValidateRequestParameters

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

Indicates whether to validate request parameters.

builder

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

Returns:

a CfnRequestValidatorProps.Builder of CfnRequestValidatorProps