Struct aws_sdk_waf::operation::create_rule::builders::CreateRuleFluentBuilder

pub struct CreateRuleFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateRule.

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 Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

• An IPSet that matches the IP address 192.0.2.44/32

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

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

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

1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

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

3. Submit a CreateRule request.

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

5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

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 CreateRuleFluentBuilder

pub fn as_input(&self) -> &CreateRuleInputBuilder

Access the CreateRule as a reference.

pub async fn send( self ) -> Result<CreateRuleOutput, SdkError<CreateRuleError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<CreateRuleOutput, CreateRuleError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

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

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

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

pub fn get_name(&self) -> &Option<String>

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

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

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.

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

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.

pub fn get_metric_name(&self) -> &Option<String>

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.

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 get_change_token(&self) -> &Option<String>

The value returned by the most recent call to GetChangeToken.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Trait Implementations

impl Clone for CreateRuleFluentBuilder

fn clone(&self) -> CreateRuleFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRuleFluentBuilder

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

Formats the value using the given formatter.