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

Class: Aws::WAFV2::Types::XssMatchStatement

Inherits:

Struct

Object
Struct
Aws::WAFV2::Types::XssMatchStatement

show all

Defined in:: (unknown)

Overview

Note:

When passing XssMatchStatement as input to an Aws::Client method, you can use a vanilla Hash:

{
  field_to_match: { # required
    single_header: {
      name: "FieldToMatchData", # required
    },
    single_query_argument: {
      name: "FieldToMatchData", # required
    },
    all_query_arguments: {
    },
    uri_path: {
    },
    query_string: {
    },
    body: {
    },
    method: {
    },
  },
  text_transformations: [ # required
    {
      priority: 1, # required
      type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE
    },
  ],
}

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

Returned by:

Statement#xss_match_statement

Instance Attribute Summary collapse

#field_to_match ⇒ Types::FieldToMatch
The part of a web request that you want AWS 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

#field_to_match ⇒ `Types::FieldToMatch`

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

Returns:

(Types::FieldToMatch) —
The part of a web request that you want AWS 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. If you specify one or more transformations in a rule statement, AWS 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.