Class ActivatedRule
- All Implemented Interfaces:
Serializable
,Cloneable
The ActivatedRule
object in an UpdateWebACL request
specifies a Rule
that you want to insert or delete, the priority
of the Rule
in the WebACL
, and the action that you
want AWS WAF to take when a web request matches the Rule
(
ALLOW
, BLOCK
, or COUNT
).
To specify whether to insert or delete a Rule
, use the
Action
parameter in the WebACLUpdate data type.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.Specifies the order in which theRules
in aWebACL
are evaluated.TheRuleId
for aRule
.int
hashCode()
void
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.void
setPriority
(Integer priority) Specifies the order in which theRules
in aWebACL
are evaluated.void
TheRuleId
for aRule
.toString()
Returns a string representation of this object; useful for testing and debugging.withAction
(WafAction action) Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in theRule
.withPriority
(Integer priority) Specifies the order in which theRules
in aWebACL
are evaluated.withRuleId
(String ruleId) TheRuleId
for aRule
.
-
Constructor Details
-
ActivatedRule
public ActivatedRule()
-
-
Method Details
-
setPriority
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.
-
getPriority
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.- Returns:
- 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.
-
withPriority
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.
-
setRuleId
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.
-
getRuleId
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.- Returns:
- 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.
-
withRuleId
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.
-
setAction
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.
- 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.
-
getAction
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.
- Returns:
- 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.
-
withAction
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.
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-