Interface ActivatedRule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ActivatedRule.Builder,
,ActivatedRule> SdkBuilder<ActivatedRule.Builder,
,ActivatedRule> SdkPojo
- Enclosing class:
ActivatedRule
-
Method Summary
Modifier and TypeMethodDescriptiondefault ActivatedRule.Builder
action
(Consumer<WafAction.Builder> action) Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.excludedRules
(Collection<ExcludedRule> excludedRules) An array of rules to exclude from a rule group.excludedRules
(Consumer<ExcludedRule.Builder>... excludedRules) An array of rules to exclude from a rule group.excludedRules
(ExcludedRule... excludedRules) An array of rules to exclude from a rule group.default ActivatedRule.Builder
overrideAction
(Consumer<WafOverrideAction.Builder> overrideAction) Use theOverrideAction
to test yourRuleGroup
.overrideAction
(WafOverrideAction overrideAction) Use theOverrideAction
to test yourRuleGroup
.Specifies the order in which theRules
in aWebACL
are evaluated.TheRuleId
for aRule
.The rule type, eitherREGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup.type
(WafRuleType type) The rule type, eitherREGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup.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
-
priority
Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.- Parameters:
priority
- Specifies the order in which theRules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don't need to be consecutive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleId
The
RuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Parameters:
ruleId
- TheRuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the
Rule
. Valid values forAction
include the following:-
ALLOW
: CloudFront responds with the requested object. -
BLOCK
: CloudFront responds with an HTTP 403 (Forbidden) status code. -
COUNT
: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case, you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.- Parameters:
action
- Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
. Valid values forAction
include the following:-
ALLOW
: CloudFront responds with the requested object. -
BLOCK
: CloudFront responds with an HTTP 403 (Forbidden) status code. -
COUNT
: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case, you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
action
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the
Rule
. Valid values forAction
include the following:-
ALLOW
: CloudFront responds with the requested object. -
BLOCK
: CloudFront responds with an HTTP 403 (Forbidden) status code. -
COUNT
: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case, you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.WafAction.Builder
avoiding the need to create one manually viaWafAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaction(WafAction)
.- Parameters:
action
- a consumer that will call methods onWafAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideAction
Use the
OverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
will block a request if any individual rule in theRuleGroup
matches the request and is configured to block that request. However if you first want to test theRuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.- Parameters:
overrideAction
- Use theOverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
will block a request if any individual rule in theRuleGroup
matches the request and is configured to block that request. However if you first want to test theRuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideAction
Use the
OverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
will block a request if any individual rule in theRuleGroup
matches the request and is configured to block that request. However if you first want to test theRuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.ActivatedRule|OverrideAction
applies only when updating or adding aRuleGroup
to aWebACL
. In this case you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.WafOverrideAction.Builder
avoiding the need to create one manually viaWafOverrideAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooverrideAction(WafOverrideAction)
.- Parameters:
overrideAction
- a consumer that will call methods onWafOverrideAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The rule type, either
REGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.- Parameters:
type
- The rule type, eitherREGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The rule type, either
REGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.- Parameters:
type
- The rule type, eitherREGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
excludedRules
An array of rules to exclude from a rule group. This is applicable only when the
ActivatedRule
refers to aRuleGroup
.Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying
ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
-
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
-
Submit an UpdateWebACL request that has two actions:
-
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first
Updates:Action
should beDELETE
andUpdates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude. -
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second
Updates:Action
should beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
-
- Parameters:
excludedRules
- An array of rules to exclude from a rule group. This is applicable only when theActivatedRule
refers to aRuleGroup
.Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying
ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
-
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
-
Submit an UpdateWebACL request that has two actions:
-
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first
Updates:Action
should beDELETE
andUpdates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude. -
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second
Updates:Action
should beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
excludedRules
An array of rules to exclude from a rule group. This is applicable only when the
ActivatedRule
refers to aRuleGroup
.Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying
ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
-
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
-
Submit an UpdateWebACL request that has two actions:
-
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first
Updates:Action
should beDELETE
andUpdates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude. -
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second
Updates:Action
should beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
-
- Parameters:
excludedRules
- An array of rules to exclude from a rule group. This is applicable only when theActivatedRule
refers to aRuleGroup
.Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying
ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
-
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
-
Submit an UpdateWebACL request that has two actions:
-
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first
Updates:Action
should beDELETE
andUpdates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude. -
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second
Updates:Action
should beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
excludedRules
An array of rules to exclude from a rule group. This is applicable only when the
ActivatedRule
refers to aRuleGroup
.Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying
ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
-
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
-
Submit an UpdateWebACL request that has two actions:
-
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first
Updates:Action
should beDELETE
andUpdates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude. -
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second
Updates:Action
should beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
-
ExcludedRule.Builder
avoiding the need to create one manually viaExcludedRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexcludedRules(List<ExcludedRule>)
.- Parameters:
excludedRules
- a consumer that will call methods onExcludedRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-