Struct aws_sdk_wafv2::types::Rule
source · #[non_exhaustive]pub struct Rule {
pub name: String,
pub priority: i32,
pub statement: Option<Statement>,
pub action: Option<RuleAction>,
pub override_action: Option<OverrideAction>,
pub rule_labels: Option<Vec<Label>>,
pub visibility_config: Option<VisibilityConfig>,
pub captcha_config: Option<CaptchaConfig>,
pub challenge_config: Option<ChallengeConfig>,
}
Expand description
A single rule, which you can use in a WebACL
or RuleGroup
to identify web requests that you want to manage in some way. Each rule includes one top-level Statement
that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: String
The name of the rule.
If you change the name of a Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig
settings. WAF doesn't automatically update the metric name when you update the rule name.
priority: i32
If you define more than one Rule
in a WebACL
, WAF evaluates each request against the Rules
in order based on the value of Priority
. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
statement: Option<Statement>
The WAF processing statement for the rule, for example ByteMatchStatement
or SizeConstraintStatement
.
action: Option<RuleAction>
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
You must specify either this Action
setting or the rule OverrideAction
setting, but not both:
-
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
-
If the rule statement references a rule group, use the override action setting and not this action setting.
override_action: Option<OverrideAction>
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count
action, in your rule group reference statement settings.
rule_labels: Option<Vec<Label>>
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement
.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
-
Separate each component of the label with a colon.
-
Each namespace or name can have up to 128 characters.
-
You can specify up to 5 namespaces in a label.
-
Don't use the following reserved words in your label specification:
aws
,waf
,managed
,rulegroup
,webacl
,regexpatternset
, oripset
.
For example, myLabelName
or nameSpace1:nameSpace2:myLabelName
.
visibility_config: Option<VisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. WAF doesn't automatically update the metric name.
captcha_config: Option<CaptchaConfig>
Specifies how WAF should handle CAPTCHA
evaluations. If you don't specify this, WAF uses the CAPTCHA
configuration that's defined for the web ACL.
challenge_config: Option<ChallengeConfig>
Specifies how WAF should handle Challenge
evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.
Implementations§
source§impl Rule
impl Rule
sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
The name of the rule.
If you change the name of a Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig
settings. WAF doesn't automatically update the metric name when you update the rule name.
sourcepub fn priority(&self) -> i32
pub fn priority(&self) -> i32
If you define more than one Rule
in a WebACL
, WAF evaluates each request against the Rules
in order based on the value of Priority
. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
sourcepub fn statement(&self) -> Option<&Statement>
pub fn statement(&self) -> Option<&Statement>
The WAF processing statement for the rule, for example ByteMatchStatement
or SizeConstraintStatement
.
sourcepub fn action(&self) -> Option<&RuleAction>
pub fn action(&self) -> Option<&RuleAction>
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
You must specify either this Action
setting or the rule OverrideAction
setting, but not both:
-
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
-
If the rule statement references a rule group, use the override action setting and not this action setting.
sourcepub fn override_action(&self) -> Option<&OverrideAction>
pub fn override_action(&self) -> Option<&OverrideAction>
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count
action, in your rule group reference statement settings.
sourcepub fn rule_labels(&self) -> &[Label]
pub fn rule_labels(&self) -> &[Label]
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement
.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
-
Separate each component of the label with a colon.
-
Each namespace or name can have up to 128 characters.
-
You can specify up to 5 namespaces in a label.
-
Don't use the following reserved words in your label specification:
aws
,waf
,managed
,rulegroup
,webacl
,regexpatternset
, oripset
.
For example, myLabelName
or nameSpace1:nameSpace2:myLabelName
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rule_labels.is_none()
.
sourcepub fn visibility_config(&self) -> Option<&VisibilityConfig>
pub fn visibility_config(&self) -> Option<&VisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. WAF doesn't automatically update the metric name.
sourcepub fn captcha_config(&self) -> Option<&CaptchaConfig>
pub fn captcha_config(&self) -> Option<&CaptchaConfig>
Specifies how WAF should handle CAPTCHA
evaluations. If you don't specify this, WAF uses the CAPTCHA
configuration that's defined for the web ACL.
sourcepub fn challenge_config(&self) -> Option<&ChallengeConfig>
pub fn challenge_config(&self) -> Option<&ChallengeConfig>
Specifies how WAF should handle Challenge
evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.