UpdateByteMatchSetRequest Class | AWS SDK for .NET V3

Container for the parameters to the UpdateByteMatchSet 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 ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

Create a ByteMatchSet. For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

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.WAFRegional.AmazonWAFRegionalRequest
      Amazon.WAFRegional.Model.UpdateByteMatchSetRequest

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

Syntax

public class UpdateByteMatchSetRequest : AmazonWAFRegionalRequest
         IAmazonWebServiceRequest

The UpdateByteMatchSetRequest type exposes the following members

Constructors

	Name	Description
	UpdateByteMatchSetRequest()

Properties

Name Type Description

Name	Type	Description
ByteMatchSetId	System.String	Gets and sets the property ByteMatchSetId. The `ByteMatchSetId` of the ByteMatchSet that you want to update. `ByteMatchSetId` is returned by CreateByteMatchSet and by ListByteMatchSets.
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.WAFRegional.Model.ByteMatchSetUpdate>	Gets and sets the property Updates. An array of `ByteMatchSetUpdate` objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: ByteMatchSetUpdate: Contains `Action` and `ByteMatchTuple` ByteMatchTuple: Contains `FieldToMatch`, `PositionalConstraint`, `TargetString`, and `TextTransformation` FieldToMatch: Contains `Data` and `Type`

ByteMatchSetId

System.String

Gets and sets the property ByteMatchSetId.

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

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.WAFRegional.Model.ByteMatchSetUpdate>

Gets and sets the property Updates.

An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

ByteMatchSetUpdate: Contains Action and ByteMatchTuple
ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation
FieldToMatch: Contains Data and Type

Examples

The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

To update a byte match set


var client = new AmazonWAFRegionalClient();
var response = client.UpdateByteMatchSet(new UpdateByteMatchSetRequest 
{
    ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    Updates = new List<ByteMatchSetUpdate> {
        new ByteMatchSetUpdate {
            Action = "DELETE",
            ByteMatchTuple = new ByteMatchTuple {
                FieldToMatch = new FieldToMatch {
                    Data = "referer",
                    Type = "HEADER"
                },
                PositionalConstraint = "CONTAINS",
                TextTransformation = "NONE"
            }
        }
    }
});

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