AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateByteMatchSet operation. Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

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:

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

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

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

C#
public class UpdateByteMatchSetRequest : AmazonWAFRegionalRequest
         IAmazonWebServiceRequest

The UpdateByteMatchSetRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateByteMatchSetRequest()

Properties

NameTypeDescription
Public Property 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.

Public Property ChangeToken System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

Public Property 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:

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 response = client.UpdateByteMatchSet(new UpdateByteMatchSetRequest 
{
    ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    Updates = new List {
        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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms