CfnRequestValidatorProps¶
-
class
aws_cdk.aws_apigateway.
CfnRequestValidatorProps
(*, rest_api_id, name=None, validate_request_body=None, validate_request_parameters=None)¶ Bases:
object
Properties for defining a
CfnRequestValidator
.- Parameters
rest_api_id (
str
) – The identifier of the targeted API entity.name (
Optional
[str
]) – The name of this request validator.validate_request_body (
Union
[bool
,IResolvable
,None
]) – Indicates whether to validate the request body according to the configured schema for the targeted API and method.validate_request_parameters (
Union
[bool
,IResolvable
,None
]) – Indicates whether to validate request parameters.
- Link
- 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 cfn_request_validator_props = apigateway.CfnRequestValidatorProps( rest_api_id="restApiId", # the properties below are optional name="name", validate_request_body=False, validate_request_parameters=False )
Attributes
-
name
¶ The name of this request validator.
-
rest_api_id
¶ The identifier of the targeted API entity.
-
validate_request_body
¶ Indicates whether to validate the request body according to the configured schema for the targeted API and method.
-
validate_request_parameters
¶ Indicates whether to validate request parameters.