Class: Aws::APIGateway::Types::RequestValidator

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

A set of validation rules for incoming Method requests.

<div class=“remarks” markdown=“1”> In OpenAPI, a RequestValidator of an API is defined by the

x-amazon-apigateway-request-validators.requestValidator][1

object.

It the referenced using the [x-amazon-apigateway-request-validator] property.

</div>

<div class=“seeAlso” markdown=“1”>

Enable Basic Request Validation in API Gateway][3

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator [3]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

The identifier of this RequestValidator.

Returns:

  • (String) 


6215
6216
6217
6218
6219
6220
6221
6222
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6215

class RequestValidator < Struct.new(
  :id,
  :name,
  :validate_request_body,
  :validate_request_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of this RequestValidator

Returns:

  • (String) 


6215
6216
6217
6218
6219
6220
6221
6222
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6215

class RequestValidator < Struct.new(
  :id,
  :name,
  :validate_request_body,
  :validate_request_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#validate_request_body ⇒ Boolean

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

Returns:

  • (Boolean) 


6215
6216
6217
6218
6219
6220
6221
6222
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6215

class RequestValidator < Struct.new(
  :id,
  :name,
  :validate_request_body,
  :validate_request_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#validate_request_parameters ⇒ Boolean

A Boolean flag to indicate whether to validate request parameters (‘true`) or not (`false`).

Returns:

  • (Boolean) 


6215
6216
6217
6218
6219
6220
6221
6222
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6215

class RequestValidator < Struct.new(
  :id,
  :name,
  :validate_request_body,
  :validate_request_parameters)
  SENSITIVE = []
  include Aws::Structure
end