/AWS1/CL_WAR=>UPDATEXSSMATCHSET()
¶
About UpdateXssMatchSet¶
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 anXssMatchTuple
, 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:
-
Submit a CreateXssMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateXssMatchSet
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_XSSMATCHSETID
TYPE /AWS1/WARRESOURCEID
/AWS1/WARRESOURCEID
¶
The
XssMatchSetId
of theXssMatchSet
that you want to update.XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
IV_CHANGETOKEN
TYPE /AWS1/WARCHANGETOKEN
/AWS1/WARCHANGETOKEN
¶
The value returned by the most recent call to GetChangeToken.
IT_UPDATES
TYPE /AWS1/CL_WARXSSMATCHSETUPDATE=>TT_XSSMATCHSETUPDATES
TT_XSSMATCHSETUPDATES
¶
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
andXssMatchTuple
XssMatchTuple: Contains
FieldToMatch
andTextTransformation
FieldToMatch: Contains
Data
andType