Struct aws_sdk_wafv2::types::builders::RuleGroupBuilder

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

A builder for RuleGroup.

Implementations

impl RuleGroupBuilder

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.

This field is required.

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

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

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.

This field is required.

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

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 capacity(self, input: i64) -> Self

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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.

This field is required.

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

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

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

The Amazon Resource Name (ARN) of the entity.

This field is required.

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

The Amazon Resource Name (ARN) of the entity.

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

The Amazon Resource Name (ARN) of the entity.

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

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

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for your rule groups is the following:

  awswaf: :rulegroup: :

• 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 rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for your rule groups is the following:

  awswaf: :rulegroup: :

• 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 rule group. All labels added by rules in this rule group have this prefix.

• The syntax for the label namespace prefix for your rule groups is the following:

  awswaf: :rulegroup: :

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

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 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 available_labels(self, input: LabelSummary) -> Self

Appends an item to available_labels.

To override the contents of this collection use set_available_labels.

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

pub fn set_available_labels(self, input: Option<Vec<LabelSummary>>) -> Self

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

pub fn get_available_labels(&self) -> &Option<Vec<LabelSummary>>

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

pub fn consumed_labels(self, input: LabelSummary) -> Self

Appends an item to consumed_labels.

To override the contents of this collection use set_consumed_labels.

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

pub fn set_consumed_labels(self, input: Option<Vec<LabelSummary>>) -> Self

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

pub fn get_consumed_labels(&self) -> &Option<Vec<LabelSummary>>

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

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

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

• name
• id
• capacity
• arn

Trait Implementations

impl Clone for RuleGroupBuilder

fn clone(&self) -> RuleGroupBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuleGroupBuilder

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

Formats the value using the given formatter.

impl Default for RuleGroupBuilder

fn default() -> RuleGroupBuilder

Returns the “default value” for a type.

impl PartialEq for RuleGroupBuilder

fn eq(&self, other: &RuleGroupBuilder) -> 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 RuleGroupBuilder