Struct aws_sdk_waf::client::fluent_builders::CreateByteMatchSet

pub struct CreateByteMatchSet<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateByteMatchSet.

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.

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

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

1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

2. Submit a CreateByteMatchSet request.

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

4. 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<C, M, R> CreateByteMatchSet<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateByteMatchSetOutput, SdkError<CreateByteMatchSetError>> where
    R::Policy: SmithyRetryPolicy<CreateByteMatchSetInputOperationOutputAlias, CreateByteMatchSetOutput, CreateByteMatchSetError, CreateByteMatchSetInputOperationRetryAlias>, 

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 name(self, input: impl Into<String>) -> Self

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

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

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateByteMatchSet<C, M, R>

fn clone(&self) -> CreateByteMatchSet<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateByteMatchSet<C, M, R>

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

Formats the value using the given formatter.