Skip to content

Update Xss Match Set

waf_update_xss_match_set R Documentation

This is AWS WAF Classic documentation

Description

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 WAFV2 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.

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

    You can only specify a single type of TextTransformation.

You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure an XssMatchSet, perform the following steps:

  1. Submit a create_xss_match_set request.

  2. Use get_change_token to get the change token that you provide in the ChangeToken parameter of an update_ip_set request.

  3. Submit an update_xss_match_set request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Usage

waf_update_xss_match_set(XssMatchSetId, ChangeToken, Updates)

Arguments

XssMatchSetId

[required] The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by create_xss_match_set and by list_xss_match_sets.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Updates

[required] An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

  • XssMatchSetUpdate: Contains Action and XssMatchTuple

  • XssMatchTuple: Contains FieldToMatch and TextTransformation

  • FieldToMatch: Contains Data and Type

Value

A list with the following syntax: 

list(
  ChangeToken = "string"
)

Request syntax

svc$update_xss_match_set(
  XssMatchSetId = "string",
  ChangeToken = "string",
  Updates = list(
    list(
      Action = "INSERT"|"DELETE",
      XssMatchTuple = list(
        FieldToMatch = list(
          Type = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS",
          Data = "string"
        ),
        TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"
      )
    )
  )
)

Examples

## Not run: 
# The following example deletes an XssMatchTuple object (filters) in an
# XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
svc$update_xss_match_set(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  Updates = list(
    list(
      Action = "DELETE",
      XssMatchTuple = list(
        FieldToMatch = list(
          Type = "QUERY_STRING"
        ),
        TextTransformation = "URL_DECODE"
      )
    )
  ),
  XssMatchSetId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
)

## End(Not run)