Class: AWSCDK::WAFv2::CfnWebACL::URIFragmentProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wa_fv2/cfn_web_acl.rb

Overview

Inspect fragments of the request URI.

You can specify the parts of the URI fragment to inspect and you can narrow the set of URI fragments to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "UriFragment": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fallback_behavior: nil) ⇒ URIFragmentProperty

Returns a new instance of URIFragmentProperty.

Parameters:

  • fallback_behavior (String, nil) (defaults to: nil)

    What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:.



6395
6396
6397
6398
# File 'wa_fv2/cfn_web_acl.rb', line 6395

def initialize(fallback_behavior: nil)
  @fallback_behavior = fallback_behavior
  Jsii::Type.check_type(@fallback_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fallbackBehavior") unless @fallback_behavior.nil?
end

Instance Attribute Details

#fallback_behaviorString? (readonly)

What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:.

  • EVALUATE_AS_STRING - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
  • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
  • NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.

Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} }

AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see JSON body in the AWS WAF Developer Guide .



6414
6415
6416
# File 'wa_fv2/cfn_web_acl.rb', line 6414

def fallback_behavior
  @fallback_behavior
end

Class Method Details

.jsii_propertiesObject



6416
6417
6418
6419
6420
# File 'wa_fv2/cfn_web_acl.rb', line 6416

def self.jsii_properties
  {
    :fallback_behavior => "fallbackBehavior",
  }
end

Instance Method Details

#to_jsiiObject



6422
6423
6424
6425
6426
6427
6428
# File 'wa_fv2/cfn_web_acl.rb', line 6422

def to_jsii
  result = {}
  result.merge!({
    "fallbackBehavior" => @fallback_behavior,
  })
  result.compact
end