Struct aws_sdk_waf::client::fluent_builders::UpdateByteMatchSet

pub struct UpdateByteMatchSet { /* private fields */ }

Fluent builder constructing a request to UpdateByteMatchSet.

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:

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.

Implementations

impl UpdateByteMatchSet

pub async fn send(
    self
) -> Result<UpdateByteMatchSetOutput, SdkError<UpdateByteMatchSetError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn byte_match_set_id(self, input: impl Into<String>) -> Self

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

pub fn set_byte_match_set_id(self, input: Option<String>) -> Self

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

pub fn change_token(self, input: impl Into<String>) -> Self

The value returned by the most recent call to GetChangeToken.

pub fn set_change_token(self, input: Option<String>) -> Self

The value returned by the most recent call to GetChangeToken.

pub fn updates(self, input: ByteMatchSetUpdate) -> Self

Appends an item to Updates.

To override the contents of this collection use set_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

pub fn set_updates(self, input: Option<Vec<ByteMatchSetUpdate>>) -> Self

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

Trait Implementations

impl Clone for UpdateByteMatchSet

fn clone(&self) -> UpdateByteMatchSet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateByteMatchSet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.