Interface Rule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Rule.Builder,
,Rule> SdkBuilder<Rule.Builder,
,Rule> SdkPojo
- Enclosing class:
Rule
-
Method Summary
Modifier and TypeMethodDescriptiondefault Rule.Builder
action
(Consumer<RuleAction.Builder> action) The action that WAF should take on a web request when it matches the rule statement.action
(RuleAction action) The action that WAF should take on a web request when it matches the rule statement.default Rule.Builder
captchaConfig
(Consumer<CaptchaConfig.Builder> captchaConfig) Specifies how WAF should handleCAPTCHA
evaluations.captchaConfig
(CaptchaConfig captchaConfig) Specifies how WAF should handleCAPTCHA
evaluations.default Rule.Builder
challengeConfig
(Consumer<ChallengeConfig.Builder> challengeConfig) Specifies how WAF should handleChallenge
evaluations.challengeConfig
(ChallengeConfig challengeConfig) Specifies how WAF should handleChallenge
evaluations.The name of the rule.default Rule.Builder
overrideAction
(Consumer<OverrideAction.Builder> overrideAction) The action to use in the place of the action that results from the rule group evaluation.overrideAction
(OverrideAction overrideAction) The action to use in the place of the action that results from the rule group evaluation.If you define more than oneRule
in aWebACL
, WAF evaluates each request against theRules
in order based on the value ofPriority
.ruleLabels
(Collection<Label> ruleLabels) Labels to apply to web requests that match the rule match statement.ruleLabels
(Consumer<Label.Builder>... ruleLabels) Labels to apply to web requests that match the rule match statement.ruleLabels
(Label... ruleLabels) Labels to apply to web requests that match the rule match statement.default Rule.Builder
statement
(Consumer<Statement.Builder> statement) The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.default Rule.Builder
visibilityConfig
(Consumer<VisibilityConfig.Builder> visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.visibilityConfig
(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
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'sVisibilityConfig
settings. WAF doesn't automatically update the metric name when you update the rule name.- Parameters:
name
- 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'sVisibilityConfig
settings. WAF doesn't automatically update the metric name when you update the rule name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
priority
If you define more than one
Rule
in aWebACL
, WAF evaluates each request against theRules
in order based on the value ofPriority
. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.- Parameters:
priority
- If you define more than oneRule
in aWebACL
, WAF evaluates each request against theRules
in order based on the value ofPriority
. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statement
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
- Parameters:
statement
- The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statement
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
This is a convenience method that creates an instance of theStatement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatement(Statement)
.- Parameters:
statement
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
action
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
andManagedRuleGroupStatement
.You must specify either this
Action
setting or the ruleOverrideAction
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.
- Parameters:
action
- 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
andManagedRuleGroupStatement
.You must specify either this
Action
setting or the ruleOverrideAction
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
action
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
andManagedRuleGroupStatement
.You must specify either this
Action
setting or the ruleOverrideAction
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.
RuleAction.Builder
avoiding the need to create one manually viaRuleAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaction(RuleAction)
.- Parameters:
action
- a consumer that will call methods onRuleAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
andManagedRuleGroupStatement
.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.- Parameters:
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
andManagedRuleGroupStatement
.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
andManagedRuleGroupStatement
.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.OverrideAction.Builder
avoiding the need to create one manually viaOverrideAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooverrideAction(OverrideAction)
.- Parameters:
overrideAction
- a consumer that will call methods onOverrideAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ruleLabels
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
ornameSpace1:nameSpace2:myLabelName
.- Parameters:
ruleLabels
- 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
ornameSpace1:nameSpace2:myLabelName
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
ruleLabels
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
ornameSpace1:nameSpace2:myLabelName
.- Parameters:
ruleLabels
- 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
ornameSpace1:nameSpace2:myLabelName
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
ruleLabels
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,
This is a convenience method that creates an instance of themyLabelName
ornameSpace1:nameSpace2:myLabelName
.Label.Builder
avoiding the need to create one manually viaLabel.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruleLabels(List<Label>)
.- Parameters:
ruleLabels
- a consumer that will call methods onLabel.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
This is a convenience method that creates an instance of theRule
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.VisibilityConfig.Builder
avoiding the need to create one manually viaVisibilityConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisibilityConfig(VisibilityConfig)
.- Parameters:
visibilityConfig
- a consumer that will call methods onVisibilityConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
captchaConfig
Specifies how WAF should handle
CAPTCHA
evaluations. If you don't specify this, WAF uses theCAPTCHA
configuration that's defined for the web ACL.- Parameters:
captchaConfig
- Specifies how WAF should handleCAPTCHA
evaluations. If you don't specify this, WAF uses theCAPTCHA
configuration that's defined for the web ACL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
captchaConfig
Specifies how WAF should handle
This is a convenience method that creates an instance of theCAPTCHA
evaluations. If you don't specify this, WAF uses theCAPTCHA
configuration that's defined for the web ACL.CaptchaConfig.Builder
avoiding the need to create one manually viaCaptchaConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocaptchaConfig(CaptchaConfig)
.- Parameters:
captchaConfig
- a consumer that will call methods onCaptchaConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
challengeConfig
- Specifies how WAF should handleChallenge
evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
challengeConfig
Specifies how WAF should handle
This is a convenience method that creates an instance of theChallenge
evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL.ChallengeConfig.Builder
avoiding the need to create one manually viaChallengeConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochallengeConfig(ChallengeConfig)
.- Parameters:
challengeConfig
- a consumer that will call methods onChallengeConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-