@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsWafWebAclRule extends Object implements Serializable, Cloneable, StructuredPojo
Details for a rule in an WAF web ACL.
Constructor and Description |
---|
AwsWafWebAclRule() |
Modifier and Type | Method and Description |
---|---|
AwsWafWebAclRule |
clone() |
boolean |
equals(Object obj) |
WafAction |
getAction()
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
|
List<WafExcludedRule> |
getExcludedRules()
Rules to exclude from a rule group.
|
WafOverrideAction |
getOverrideAction()
Use the
OverrideAction to test your RuleGroup . |
Integer |
getPriority()
Specifies the order in which the rules in a web ACL are evaluated.
|
String |
getRuleId()
The identifier for a rule.
|
String |
getType()
The rule type.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAction(WafAction action)
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
|
void |
setExcludedRules(Collection<WafExcludedRule> excludedRules)
Rules to exclude from a rule group.
|
void |
setOverrideAction(WafOverrideAction overrideAction)
Use the
OverrideAction to test your RuleGroup . |
void |
setPriority(Integer priority)
Specifies the order in which the rules in a web ACL are evaluated.
|
void |
setRuleId(String ruleId)
The identifier for a rule.
|
void |
setType(String type)
The rule type.
|
String |
toString()
Returns a string representation of this object.
|
AwsWafWebAclRule |
withAction(WafAction action)
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
|
AwsWafWebAclRule |
withExcludedRules(Collection<WafExcludedRule> excludedRules)
Rules to exclude from a rule group.
|
AwsWafWebAclRule |
withExcludedRules(WafExcludedRule... excludedRules)
Rules to exclude from a rule group.
|
AwsWafWebAclRule |
withOverrideAction(WafOverrideAction overrideAction)
Use the
OverrideAction to test your RuleGroup . |
AwsWafWebAclRule |
withPriority(Integer priority)
Specifies the order in which the rules in a web ACL are evaluated.
|
AwsWafWebAclRule |
withRuleId(String ruleId)
The identifier for a rule.
|
AwsWafWebAclRule |
withType(String type)
The rule type.
|
public void setAction(WafAction action)
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
action
- Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.public WafAction getAction()
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
public AwsWafWebAclRule withAction(WafAction action)
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
action
- Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.public List<WafExcludedRule> getExcludedRules()
Rules to exclude from a rule group.
public void setExcludedRules(Collection<WafExcludedRule> excludedRules)
Rules to exclude from a rule group.
excludedRules
- Rules to exclude from a rule group.public AwsWafWebAclRule withExcludedRules(WafExcludedRule... excludedRules)
Rules to exclude from a rule group.
NOTE: This method appends the values to the existing list (if any). Use
setExcludedRules(java.util.Collection)
or withExcludedRules(java.util.Collection)
if you want
to override the existing values.
excludedRules
- Rules to exclude from a rule group.public AwsWafWebAclRule withExcludedRules(Collection<WafExcludedRule> excludedRules)
Rules to exclude from a rule group.
excludedRules
- Rules to exclude from a rule group.public void setOverrideAction(WafOverrideAction overrideAction)
Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the OverrideAction
to None
, the RuleGroup
blocks a request if any individual rule in the
RuleGroup
matches the request and is configured to block that request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual rules
contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
.
For all other update requests, ActivatedRule
Action
is used instead of
ActivatedRule
OverrideAction
.
overrideAction
- Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the
OverrideAction
to None
, the RuleGroup
blocks a request if any
individual rule in the RuleGroup
matches the request and is configured to block that request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual
rules contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
. For all other update requests, ActivatedRule
Action
is used
instead of ActivatedRule
OverrideAction
.
public WafOverrideAction getOverrideAction()
Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the OverrideAction
to None
, the RuleGroup
blocks a request if any individual rule in the
RuleGroup
matches the request and is configured to block that request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual rules
contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
.
For all other update requests, ActivatedRule
Action
is used instead of
ActivatedRule
OverrideAction
.
OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the
OverrideAction
to None
, the RuleGroup
blocks a request if any
individual rule in the RuleGroup
matches the request and is configured to block that
request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual
rules contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
. For all other update requests, ActivatedRule
Action
is
used instead of ActivatedRule
OverrideAction
.
public AwsWafWebAclRule withOverrideAction(WafOverrideAction overrideAction)
Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the OverrideAction
to None
, the RuleGroup
blocks a request if any individual rule in the
RuleGroup
matches the request and is configured to block that request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual rules
contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
.
For all other update requests, ActivatedRule
Action
is used instead of
ActivatedRule
OverrideAction
.
overrideAction
- Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the
OverrideAction
to None
, the RuleGroup
blocks a request if any
individual rule in the RuleGroup
matches the request and is configured to block that request.
However, if you first want to test the RuleGroup
, set the OverrideAction
to
Count
. The RuleGroup
then overrides any block action specified by individual
rules contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule
|OverrideAction
applies only when updating or adding a
RuleGroup
to a web ACL. In this case you do not use ActivatedRule
Action
. For all other update requests, ActivatedRule
Action
is used
instead of ActivatedRule
OverrideAction
.
public void setPriority(Integer priority)
Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for
Priority
are evaluated before rules with a higher value. The value must be a unique integer. If you
add multiple rules to a web ACL, the values do not need to be consecutive.
priority
- Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for
Priority
are evaluated before rules with a higher value. The value must be a unique integer.
If you add multiple rules to a web ACL, the values do not need to be consecutive.public Integer getPriority()
Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for
Priority
are evaluated before rules with a higher value. The value must be a unique integer. If you
add multiple rules to a web ACL, the values do not need to be consecutive.
Priority
are evaluated before rules with a higher value. The value must be a unique integer.
If you add multiple rules to a web ACL, the values do not need to be consecutive.public AwsWafWebAclRule withPriority(Integer priority)
Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for
Priority
are evaluated before rules with a higher value. The value must be a unique integer. If you
add multiple rules to a web ACL, the values do not need to be consecutive.
priority
- Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for
Priority
are evaluated before rules with a higher value. The value must be a unique integer.
If you add multiple rules to a web ACL, the values do not need to be consecutive.public void setRuleId(String ruleId)
The identifier for a rule.
ruleId
- The identifier for a rule.public String getRuleId()
The identifier for a rule.
public AwsWafWebAclRule withRuleId(String ruleId)
The identifier for a rule.
ruleId
- The identifier for a rule.public void setType(String type)
The rule type.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
type
- The rule type.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
public String getType()
The rule type.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
public AwsWafWebAclRule withType(String type)
The rule type.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
type
- The rule type.
Valid values: REGULAR
| RATE_BASED
| GROUP
The default is REGULAR
.
public String toString()
toString
in class Object
Object.toString()
public AwsWafWebAclRule clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.