RequestValidatorProps

class aws_cdk.aws_apigateway.RequestValidatorProps(*, request_validator_name=None, validate_request_body=None, validate_request_parameters=None, rest_api)

Bases: aws_cdk.aws_apigateway.RequestValidatorOptions

__init__(*, request_validator_name=None, validate_request_body=None, validate_request_parameters=None, rest_api)
Parameters
  • request_validator_name (Optional[str]) – The name of this request validator. Default: None

  • validate_request_body (Optional[bool]) – Indicates whether to validate the request body according to the configured schema for the targeted API and method. Default: false

  • validate_request_parameters (Optional[bool]) – Indicates whether to validate request parameters. Default: false

  • rest_api (IRestApi) – 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.

Attributes

request_validator_name

The name of this request validator.

default :default: None

Return type

Optional[str]

rest_api

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.

Return type

IRestApi

validate_request_body

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

default :default: false

Return type

Optional[bool]

validate_request_parameters

Indicates whether to validate request parameters.

default :default: false

Return type

Optional[bool]