Class: Aws::WAFV2::Types::RegexPatternSetReferenceStatement

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::RegexPatternSetReferenceStatement

Includes:

Structure

Defined in:

lib/aws-sdk-wafv2/types.rb

Overview

Note:

When making an API call, you may pass RegexPatternSetReferenceStatement data as a hash:

{
  arn: "ResourceArn", # required
  field_to_match: { # required
    single_header: {
      name: "FieldToMatchData", # required
    },
    single_query_argument: {
      name: "FieldToMatchData", # required
    },
    all_query_arguments: {
    },
    uri_path: {
    },
    query_string: {
    },
    body: {
      oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
    },
    method: {
    },
    json_body: {
      match_pattern: { # required
        all: {
        },
        included_paths: ["JsonPointerPath"],
      },
      match_scope: "ALL", # required, accepts ALL, KEY, VALUE
      invalid_fallback_behavior: "MATCH", # accepts MATCH, NO_MATCH, EVALUATE_AS_STRING
      oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
    },
    headers: {
      match_pattern: { # required
        all: {
        },
        included_headers: ["FieldToMatchData"],
        excluded_headers: ["FieldToMatchData"],
      },
      match_scope: "ALL", # required, accepts ALL, KEY, VALUE
      oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
    },
    cookies: {
      match_pattern: { # required
        all: {
        },
        included_cookies: ["SingleCookieName"],
        excluded_cookies: ["SingleCookieName"],
      },
      match_scope: "ALL", # required, accepts ALL, KEY, VALUE
      oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
    },
  },
  text_transformations: [ # required
    {
      priority: 1, # required
      type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
    },
  ],
}

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

• #field_to_match ⇒ Types::FieldToMatch

  The part of the web request that you want WAF to inspect.

• #text_transformations ⇒ Array<Types::TextTransformation>

  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

Returns:

• (String)

# File 'lib/aws-sdk-wafv2/types.rb', line 9899

class RegexPatternSetReferenceStatement < Struct.new(
  :arn,
  :field_to_match,
  :text_transformations)
  SENSITIVE = []
  include Aws::Structure
end

#field_to_match ⇒ Types::FieldToMatch

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

Returns:

• (Types::FieldToMatch)

# File 'lib/aws-sdk-wafv2/types.rb', line 9899

class RegexPatternSetReferenceStatement < Struct.new(
  :arn,
  :field_to_match,
  :text_transformations)
  SENSITIVE = []
  include Aws::Structure
end

#text_transformations ⇒ Array<Types::TextTransformation>

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match.

Returns:

• (Array<Types::TextTransformation>)

# File 'lib/aws-sdk-wafv2/types.rb', line 9899

class RegexPatternSetReferenceStatement < Struct.new(
  :arn,
  :field_to_match,
  :text_transformations)
  SENSITIVE = []
  include Aws::Structure
end