RequestValidator

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

Bases: Resource

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 = apigateway.RequestValidator(self, "MyRequestValidator",
    rest_api=rest_api,

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

  • scope (Construct) –

  • id (str) –

  • 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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The construct tree node associated with this construct.

request_validator_id

ID of the request validator, such as abc123.

Attribute:

true

stack

The stack in which this resource is defined.

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

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool