aws-cdk-lib.aws_apigateway.RequestValidatorOptions

RequestValidatorOptions Struct

Source

aws-apigateway/lib/requestvalidator.ts

Example

declare const integration: apigateway.LambdaIntegration;
declare const resource: apigateway.Resource;
declare const responseModel: apigateway.Model;
declare const errorResponseModel: apigateway.Model;

resource.addMethod('GET', integration, {
  // We can mark the parameters as required
  requestParameters: {
    'method.request.querystring.who': true
  },
  // we can set request validator options like below
  requestValidatorOptions: {
    requestValidatorName: 'test-validator',
    validateRequestBody: true,
    validateRequestParameters: false
  },
  methodResponses: [
    {
      // Successful response from the integration
      statusCode: '200',
      // Define what parameters are allowed or not
      responseParameters: {
        '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: {
        'application/json': responseModel
      }
    },
    {
      // Same thing for the error responses
      statusCode: '400',
      responseParameters: {
        'method.response.header.Content-Type': true,
        'method.response.header.Access-Control-Allow-Origin': true,
        'method.response.header.Access-Control-Allow-Credentials': true
      },
      responseModels: {
        'application/json': errorResponseModel
      }
    }
  ]
});

Properties

requestValidatorName?optionalstringrequest_validator_name?optionalstrrequestValidatorName?optionalStringRequestValidatorName?optionalstringRequestValidatorName?optional*string= None#

The name of this request validator.

validateRequestBody?optionalbooleanvalidate_request_body?optionalboolvalidateRequestBody?optionalBooleanValidateRequestBody?optionalboolValidateRequestBody?optional*bool= false#

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

validateRequestParameters?optionalbooleanvalidate_request_parameters?optionalboolvalidateRequestParameters?optionalBooleanValidateRequestParameters?optionalboolValidateRequestParameters?optional*bool= false#

Indicates whether to validate request parameters.