Class: AWSCDK::WAF::CfnXssMatchSet::XssMatchTupleProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
waf/cfn_xss_match_set.rb

Overview

AWS WAF Classic support will end on September 30, 2025.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(field_to_match:, text_transformation:) ⇒ XssMatchTupleProperty

Returns a new instance of XssMatchTupleProperty.

Parameters:

  • field_to_match (AWSCDK::IResolvable, AWSCDK::WAF::CfnXssMatchSet::FieldToMatchProperty) —

    The part of a web request that you want to inspect, such as a specified header or a query string.

  • text_transformation (String) —

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



590
591
592
593
594
595
 
# File 'waf/cfn_xss_match_set.rb', line 590

def initialize(field_to_match:, text_transformation:)
  @field_to_match = field_to_match.is_a?(Hash) ? ::AWSCDK::WAF::CfnXssMatchSet::FieldToMatchProperty.new(**field_to_match.transform_keys(&:to_sym)) : field_to_match
  Jsii::Type.check_type(@field_to_match, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193YWYuQ2ZuWHNzTWF0Y2hTZXQuRmllbGRUb01hdGNoUHJvcGVydHkifV19fQ==")), "fieldToMatch")
  @text_transformation = text_transformation
  Jsii::Type.check_type(@text_transformation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "textTransformation")
end

Instance Attribute Details

#field_to_match ⇒ AWSCDK::IResolvable, AWSCDK::WAF::CfnXssMatchSet::FieldToMatchProperty (readonly)

The part of a web request that you want to inspect, such as a specified header or a query string.

Returns:

See Also:



601
602
603
 
# File 'waf/cfn_xss_match_set.rb', line 601

def field_to_match
  @field_to_match
end

#text_transformation ⇒ String (readonly)

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

If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^
  • Delete spaces before the following characters: / (
  • Replace the following characters with a space: , ;
  • Replace multiple spaces with one space
  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12
  • \t, tab, decimal 9
  • \n, newline, decimal 10
  • \r, carriage return, decimal 13
  • \v, vertical tab, decimal 11
  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "
  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
  • Replaces (ampersand)lt; with a "less than" symbol
  • Replaces (ampersand)gt; with >
  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh; , with the corresponding characters
  • Replaces characters that are represented in decimal format, (ampersand)#nnnn; , with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Returns:

  • (String)

See Also:



656
657
658
 
# File 'waf/cfn_xss_match_set.rb', line 656

def text_transformation
  @text_transformation
end

Class Method Details

.jsii_properties ⇒ Object 



658
659
660
661
662
663
 
# File 'waf/cfn_xss_match_set.rb', line 658

def self.jsii_properties
  {
    :field_to_match => "fieldToMatch",
    :text_transformation => "textTransformation",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



665
666
667
668
669
670
671
672
 
# File 'waf/cfn_xss_match_set.rb', line 665

def to_jsii
  result = {}
  result.merge!({
    "fieldToMatch" => @field_to_match,
    "textTransformation" => @text_transformation,
  })
  result.compact
end