You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

A set of validation rules for incoming Method requests.

In Swagger, 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][2] property.
[Enable Basic Request Validation in API Gateway][3]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The identifier of this RequestValidator.

Returns:

  • (String)


5674
5675
5676
5677
5678
5679
5680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5674

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

#nameString

The name of this RequestValidator

Returns:

  • (String)


5674
5675
5676
5677
5678
5679
5680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5674

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

#validate_request_bodyBoolean

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

Returns:

  • (Boolean)


5674
5675
5676
5677
5678
5679
5680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5674

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

#validate_request_parametersBoolean

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

Returns:

  • (Boolean)


5674
5675
5676
5677
5678
5679
5680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5674

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