Struct aws_sdk_wafv2::client::fluent_builders::UpdateRuleGroup

pub struct UpdateRuleGroup { /* private fields */ }

Fluent builder constructing a request to UpdateRuleGroup.

Updates the specified RuleGroup.

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Implementations

impl UpdateRuleGroup

pub async fn send(
    self
) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError>>

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

The name of the rule group. You cannot change the name of a rule group after you create it.

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

The name of the rule group. You cannot change the name of a rule group after you create it.

pub fn scope(self, input: Scope) -> Self

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

pub fn set_scope(self, input: Option<Scope>) -> Self

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

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

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

A description of the rule group that helps with identification.

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

A description of the rule group that helps with identification.

pub fn rules(self, input: Rule) -> Self

Appends an item to Rules.

To override the contents of this collection use set_rules.

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

pub fn set_rules(self, input: Option<Vec<Rule>>) -> Self

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

pub fn visibility_config(self, input: VisibilityConfig) -> Self

Defines and enables Amazon CloudWatch metrics and web request sample collection.

pub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self

Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

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

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

pub fn custom_response_bodies(
    self,
    k: impl Into<String>,
    v: CustomResponseBody
) -> Self

Adds a key-value pair to CustomResponseBodies.

To override the contents of this collection use set_custom_response_bodies.

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

pub fn set_custom_response_bodies(
    self,
    input: Option<HashMap<String, CustomResponseBody>>
) -> Self

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

Trait Implementations

impl Clone for UpdateRuleGroup

fn clone(&self) -> UpdateRuleGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRuleGroup

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

Formats the value using the given formatter.