RequestValidator

class aws_cdk.aws_apigateway.RequestValidator(scope, id, *, rest_api, request_validator_name=None, validate_request_body=None, validate_request_parameters=None)

Bases: aws_cdk.core.Resource

__init__(scope, id, *, rest_api, request_validator_name=None, validate_request_body=None, validate_request_parameters=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • 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.

  • 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

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

request_validator_id

ID of the request validator, such as abc123.

attribute: :attribute:: true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_request_validator_id(scope, id, request_validator_id)
Parameters
  • scope (Construct) –

  • id (str) –

  • request_validator_id (str) –

Return type

IRequestValidator

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool