Package software.amazon.awscdk.services.apigateway

Interface RequestValidatorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RequestValidatorOptions

All Known Implementing Classes:

RequestValidatorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:56.258Z")
@Stability(Stable)
public interface RequestValidatorProps
extends software.amazon.jsii.JsiiSerializable, RequestValidatorOptions

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.*;
 RestApi restApi;
 RequestValidatorProps requestValidatorProps = RequestValidatorProps.builder()
         .restApi(restApi)
         // the properties below are optional
         .requestValidatorName("requestValidatorName")
         .validateRequestBody(false)
         .validateRequestParameters(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RequestValidatorProps.Builder	builder()
IRestApi	getRestApi()	The rest API that this model is part of.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigateway.RequestValidatorOptions

getRequestValidatorName, getValidateRequestBody, getValidateRequestParameters

Method Details

getRestApi

@Stability(Stable)
@NotNull
IRestApi getRestApi()

The rest API that this model is part of.

The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.

builder

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

Returns:

a RequestValidatorProps.Builder of RequestValidatorProps