Package software.amazon.awscdk.services.apigateway

Interface RequestValidatorOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

RequestValidatorProps

All Known Implementing Classes:

RequestValidatorOptions.Jsii$Proxy, RequestValidatorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:11.923Z")
@Stability(Stable)
public interface RequestValidatorOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 LambdaIntegration integration;
 Resource resource;
 Model responseModel;
 Model errorResponseModel;
 resource.addMethod("GET", integration, MethodOptions.builder()
         // We can mark the parameters as required
         .requestParameters(Map.of(
                 "method.request.querystring.who", true))
         // we can set request validator options like below
         .requestValidatorOptions(RequestValidatorOptions.builder()
                 .requestValidatorName("test-validator")
                 .validateRequestBody(true)
                 .validateRequestParameters(false)
                 .build())
         .methodResponses(List.of(MethodResponse.builder()
                 // Successful response from the integration
                 .statusCode("200")
                 // Define what parameters are allowed or not
                 .responseParameters(Map.of(
                         "method.response.header.Content-Type", true,
                         "method.response.header.Access-Control-Allow-Origin", true,
                         "method.response.header.Access-Control-Allow-Credentials", true))
                 // Validate the schema on the response
                 .responseModels(Map.of(
                         "application/json", responseModel))
                 .build(), MethodResponse.builder()
                 // Same thing for the error responses
                 .statusCode("400")
                 .responseParameters(Map.of(
                         "method.response.header.Content-Type", true,
                         "method.response.header.Access-Control-Allow-Origin", true,
                         "method.response.header.Access-Control-Allow-Credentials", true))
                 .responseModels(Map.of(
                         "application/json", errorResponseModel))
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RequestValidatorOptions.Builder	builder()
default String	getRequestValidatorName()	The name of this request validator.
default Boolean	getValidateRequestBody()	Indicates whether to validate the request body according to the configured schema for the targeted API and method.
default Boolean	getValidateRequestParameters()	Indicates whether to validate request parameters.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRequestValidatorName

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

The name of this request validator.

Default: None

getValidateRequestBody

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

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

Default: false

getValidateRequestParameters

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

Indicates whether to validate request parameters.

Default: false

builder

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

Returns:

a RequestValidatorOptions.Builder of RequestValidatorOptions