Struct aws_sdk_waf::client::fluent_builders::UpdateXssMatchSet

pub struct UpdateXssMatchSet { /* private fields */ }

Fluent builder constructing a request to UpdateXssMatchSet.

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:

1. Submit a CreateXssMatchSet request.

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

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

Implementations

impl UpdateXssMatchSet

pub async fn send(
    self
) -> Result<UpdateXssMatchSetOutput, SdkError<UpdateXssMatchSetError>>

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

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

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

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

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: XssMatchSetUpdate) -> Self

Appends an item to Updates.

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

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

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

Trait Implementations

impl Clone for UpdateXssMatchSet

fn clone(&self) -> UpdateXssMatchSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateXssMatchSet

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

Formats the value using the given formatter.