Class: AWSCDK::APIGateway::RequestValidatorOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/request_validator_options.rb

Direct Known Subclasses

RequestValidatorProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_validator_name: nil, validate_request_body: nil, validate_request_parameters: nil) ⇒ RequestValidatorOptions

Returns a new instance of RequestValidatorOptions.

Parameters:

  • request_validator_name (String, nil) (defaults to: nil) —

    The name of this request validator.

  • validate_request_body (Boolean, nil) (defaults to: nil) —

    Indicates whether to validate the request body according to the configured schema for the targeted API and method.

  • validate_request_parameters (Boolean, nil) (defaults to: nil) —

    Indicates whether to validate request parameters.



9
10
11
12
13
14
15
16
 
# File 'api_gateway/request_validator_options.rb', line 9

def initialize(request_validator_name: nil, validate_request_body: nil, validate_request_parameters: nil)
  @request_validator_name = request_validator_name
  Jsii::Type.check_type(@request_validator_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requestValidatorName") unless @request_validator_name.nil?
  @validate_request_body = validate_request_body
  Jsii::Type.check_type(@validate_request_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateRequestBody") unless @validate_request_body.nil?
  @validate_request_parameters = validate_request_parameters
  Jsii::Type.check_type(@validate_request_parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateRequestParameters") unless @validate_request_parameters.nil?
end

Instance Attribute Details

#request_validator_name ⇒ String? (readonly)

Note:

Default: None

The name of this request validator.

Returns:

  • (String, nil) 


22
23
24
 
# File 'api_gateway/request_validator_options.rb', line 22

def request_validator_name
  @request_validator_name
end

#validate_request_body ⇒ Boolean? (readonly)

Note:

Default: false

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

Returns:

  • (Boolean, nil) 


27
28
29
 
# File 'api_gateway/request_validator_options.rb', line 27

def validate_request_body
  @validate_request_body
end

#validate_request_parameters ⇒ Boolean? (readonly)

Note:

Default: false

Indicates whether to validate request parameters.

Returns:

  • (Boolean, nil) 


32
33
34
 
# File 'api_gateway/request_validator_options.rb', line 32

def validate_request_parameters
  @validate_request_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
40
 
# File 'api_gateway/request_validator_options.rb', line 34

def self.jsii_properties
  {
    :request_validator_name => "requestValidatorName",
    :validate_request_body => "validateRequestBody",
    :validate_request_parameters => "validateRequestParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'api_gateway/request_validator_options.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "requestValidatorName" => @request_validator_name,
    "validateRequestBody" => @validate_request_body,
    "validateRequestParameters" => @validate_request_parameters,
  })
  result.compact
end