RequestValidatorProps

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

Bases: RequestValidatorOptions

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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

# rest_api: apigateway.RestApi

request_validator_props = apigateway.RequestValidatorProps(
    rest_api=rest_api,

    # the properties below are optional
    request_validator_name="requestValidatorName",
    validate_request_body=False,
    validate_request_parameters=False
)

Attributes

request_validator_name

The name of this request validator.

Default:: None

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.

validate_request_body

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

Default:: false

validate_request_parameters

Indicates whether to validate request parameters.

Default:: false