UpdateXssMatchSetRequest Class | AWS SDK for .NET V3

Container for the parameters to the UpdateXssMatchSet operation.

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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WAF.AmazonWAFRequest
      Amazon.WAF.Model.UpdateXssMatchSetRequest

Namespace: Amazon.WAF.Model
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z

Syntax

public class UpdateXssMatchSetRequest : AmazonWAFRequest
         IAmazonWebServiceRequest

The UpdateXssMatchSetRequest type exposes the following members

Constructors

	Name	Description
	UpdateXssMatchSetRequest()

Properties

Name Type Description

Name	Type	Description
ChangeToken	System.String	Gets and sets the property ChangeToken. The value returned by the most recent call to GetChangeToken.
Updates	System.Collections.Generic.List<Amazon.WAF.Model.XssMatchSetUpdate>	Gets and sets the property Updates. 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`
XssMatchSetId	System.String	Gets and sets the property XssMatchSetId. The `XssMatchSetId` of the `XssMatchSet` that you want to update. `XssMatchSetId` is returned by CreateXssMatchSet and by ListXssMatchSets.

ChangeToken

System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

Updates

System.Collections.Generic.List<Amazon.WAF.Model.XssMatchSetUpdate>

Gets and sets the property Updates.

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

XssMatchSetId

System.String

Gets and sets the property XssMatchSetId.

The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

Examples

The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

To update an XSS match set


var client = new AmazonWAFClient();
var response = client.UpdateXssMatchSet(new UpdateXssMatchSetRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    Updates = new List<XssMatchSetUpdate> {
        new XssMatchSetUpdate {
            Action = "DELETE",
            XssMatchTuple = new XssMatchTuple {
                FieldToMatch = new FieldToMatch { Type = "QUERY_STRING" },
                TextTransformation = "URL_DECODE"
            }
        }
    },
    XssMatchSetId = "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
});

string changeToken = response.ChangeToken;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5