Struct aws_sdk_wafv2::types::builders::WebAclBuilder

#[non_exhaustive]
pub struct WebAclBuilder { /* private fields */ }

A builder for WebAcl.

Implementations

impl WebAclBuilder

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

The name of the web ACL. You cannot change the name of a web ACL after you create it.

This field is required.

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

The name of the web ACL. You cannot change the name of a web ACL after you create it.

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

The name of the web ACL. You cannot change the name of a web ACL after you create it.

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

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

This field is required.

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

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

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

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

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

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

This field is required.

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

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

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

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

pub fn default_action(self, input: DefaultAction) -> Self

The action to perform if none of the Rules contained in the WebACL match.

This field is required.

pub fn set_default_action(self, input: Option<DefaultAction>) -> Self

The action to perform if none of the Rules contained in the WebACL match.

pub fn get_default_action(&self) -> &Option<DefaultAction>

The action to perform if none of the Rules contained in the WebACL match.

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

A description of the web ACL that helps with identification.

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

A description of the web ACL that helps with identification.

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

A description of the web ACL 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 manage. 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 manage. 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 get_rules(&self) -> &Option<Vec<Rule>>

The Rule statements used to identify the web requests that you want to manage. 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.

This field is required.

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

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

pub fn get_visibility_config(&self) -> &Option<VisibilityConfig>

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

pub fn capacity(self, input: i64) -> Self

The web ACL capacity units (WCUs) currently being used by this web ACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

pub fn set_capacity(self, input: Option<i64>) -> Self

The web ACL capacity units (WCUs) currently being used by this web ACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

pub fn get_capacity(&self) -> &Option<i64>

The web ACL capacity units (WCUs) currently being used by this web ACL.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

pub fn pre_process_firewall_manager_rule_groups( self, input: FirewallManagerRuleGroup ) -> Self

Appends an item to pre_process_firewall_manager_rule_groups.

To override the contents of this collection use set_pre_process_firewall_manager_rule_groups.

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn set_pre_process_firewall_manager_rule_groups( self, input: Option<Vec<FirewallManagerRuleGroup>> ) -> Self

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn get_pre_process_firewall_manager_rule_groups( &self ) -> &Option<Vec<FirewallManagerRuleGroup>>

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn post_process_firewall_manager_rule_groups( self, input: FirewallManagerRuleGroup ) -> Self

Appends an item to post_process_firewall_manager_rule_groups.

To override the contents of this collection use set_post_process_firewall_manager_rule_groups.

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn set_post_process_firewall_manager_rule_groups( self, input: Option<Vec<FirewallManagerRuleGroup>> ) -> Self

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn get_post_process_firewall_manager_rule_groups( &self ) -> &Option<Vec<FirewallManagerRuleGroup>>

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

pub fn managed_by_firewall_manager(self, input: bool) -> Self

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

pub fn set_managed_by_firewall_manager(self, input: Option<bool>) -> Self

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

pub fn get_managed_by_firewall_manager(&self) -> &Option<bool>

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

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

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

• The syntax for the label namespace prefix for a web ACL is the following:

  awswaf: :webacl: :

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  :

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

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

• The syntax for the label namespace prefix for a web ACL is the following:

  awswaf: :webacl: :

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  :

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

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

• The syntax for the label namespace prefix for a web ACL is the following:

  awswaf: :webacl: :

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  :

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

Adds a key-value pair to custom_response_bodies.

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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 get_custom_response_bodies( &self ) -> &Option<HashMap<String, CustomResponseBody>>

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 web ACL, and then use them in the rules and default actions that you define in the web ACL.

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 captcha_config(self, input: CaptchaConfig) -> Self

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

pub fn set_captcha_config(self, input: Option<CaptchaConfig>) -> Self

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

pub fn get_captcha_config(&self) -> &Option<CaptchaConfig>

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

pub fn challenge_config(self, input: ChallengeConfig) -> Self

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

pub fn set_challenge_config(self, input: Option<ChallengeConfig>) -> Self

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

pub fn get_challenge_config(&self) -> &Option<ChallengeConfig>

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

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

Appends an item to token_domains.

To override the contents of this collection use set_token_domains.

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

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

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

pub fn get_token_domains(&self) -> &Option<Vec<String>>

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

pub fn association_config(self, input: AssociationConfig) -> Self

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

pub fn set_association_config(self, input: Option<AssociationConfig>) -> Self

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

pub fn get_association_config(&self) -> &Option<AssociationConfig>

Specifies custom configurations for the associations between the web ACL and protected resources.

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

pub fn build(self) -> Result<WebAcl, BuildError>

Consumes the builder and constructs a WebAcl. This method will fail if any of the following fields are not set:

• name
• id
• arn

Trait Implementations

impl Clone for WebAclBuilder

fn clone(&self) -> WebAclBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebAclBuilder

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

Formats the value using the given formatter.

impl Default for WebAclBuilder

fn default() -> WebAclBuilder

Returns the “default value” for a type.

impl PartialEq for WebAclBuilder

fn eq(&self, other: &WebAclBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WebAclBuilder