Class: AWSCDK::APIGateway::CfnRequestValidatorProps

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

Overview

Properties for defining a CfnRequestValidator.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rest_api_id:, name: nil, validate_request_body: nil, validate_request_parameters: nil) ⇒ CfnRequestValidatorProps

Returns a new instance of CfnRequestValidatorProps.

Parameters:

  • rest_api_id (String, AWSCDK::Interfaces::AWSApigateway::IRestAPIRef) —

    The string identifier of the associated RestApi.

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

    The name of this RequestValidator.

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

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

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

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



13
14
15
16
17
18
19
20
21
22
 
# File 'api_gateway/cfn_request_validator_props.rb', line 13

def initialize(rest_api_id:, name: nil, validate_request_body: nil, validate_request_parameters: nil)
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklSZXN0QXBpUmVmIn1dfX0=")), "restApiId")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @validate_request_body = validate_request_body
  Jsii::Type.check_type(@validate_request_body, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "validateRequestBody") unless @validate_request_body.nil?
  @validate_request_parameters = validate_request_parameters
  Jsii::Type.check_type(@validate_request_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "validateRequestParameters") unless @validate_request_parameters.nil?
end

Instance Attribute Details

#name ⇒ String? (readonly)

The name of this RequestValidator.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'api_gateway/cfn_request_validator_props.rb', line 33

def name
  @name
end

#rest_api_id ⇒ String, AWSCDK::Interfaces::AWSApigateway::IRestAPIRef (readonly)

The string identifier of the associated RestApi.

Returns:

See Also:



28
29
30
 
# File 'api_gateway/cfn_request_validator_props.rb', line 28

def rest_api_id
  @rest_api_id
end

#validate_request_body ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



38
39
40
 
# File 'api_gateway/cfn_request_validator_props.rb', line 38

def validate_request_body
  @validate_request_body
end

#validate_request_parameters ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



43
44
45
 
# File 'api_gateway/cfn_request_validator_props.rb', line 43

def validate_request_parameters
  @validate_request_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'api_gateway/cfn_request_validator_props.rb', line 45

def self.jsii_properties
  {
    :rest_api_id => "restApiId",
    :name => "name",
    :validate_request_body => "validateRequestBody",
    :validate_request_parameters => "validateRequestParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'api_gateway/cfn_request_validator_props.rb', line 54

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