Struct aws_sdk_waf::client::fluent_builders::UpdateRule

pub struct UpdateRule { /* private fields */ }

Fluent builder constructing a request to UpdateRule.

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 Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

• A ByteMatchSet that matches the value BadBot in the User-Agent header

• An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

1. Create and update the predicates that you want to include in the Rule.

2. Create the Rule. See CreateRule.

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

4. Submit an UpdateRule request to add predicates to the Rule.

5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

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 UpdateRule

pub async fn send(self) -> Result<UpdateRuleOutput, SdkError<UpdateRuleError>>

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

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

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

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

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

Appends an item to Updates.

To override the contents of this collection use set_updates.

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

• RuleUpdate: Contains Action and Predicate

• Predicate: Contains DataId, Negated, and Type

• FieldToMatch: Contains Data and Type

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

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

• RuleUpdate: Contains Action and Predicate

• Predicate: Contains DataId, Negated, and Type

• FieldToMatch: Contains Data and Type

Trait Implementations

impl Clone for UpdateRule

fn clone(&self) -> UpdateRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRule

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

Formats the value using the given formatter.