AwsWafWebAclRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsWafWebAclRule

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@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 WebACL.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsWafWebAclRule()

Constructors
Constructor and Description
`AwsWafWebAclRule()`

Method Summary

All Methods Instance Methods Concrete Methods
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 WebACL 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 WebACL 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 WebACL are evaluated.
`AwsWafWebAclRule`	`withRuleId(String ruleId)` The identifier for a rule.
`AwsWafWebAclRule`	`withType(String type)` The rule type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsWafWebAclRule
```
public AwsWafWebAclRule()
```
- Method Detail
  - setAction
```
public void setAction(WafAction action)
```
    Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
    
    Parameters:
    
    action - Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
  - getAction
```
public WafAction getAction()
```
    Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
    
    Returns:
    
    Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
  - withAction
```
public AwsWafWebAclRule withAction(WafAction action)
```
    Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
    
    Parameters:
    
    action - Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludedRules
```
public List<WafExcludedRule> getExcludedRules()
```
    Rules to exclude from a rule group.
    
    Returns:
    
    Rules to exclude from a rule group.
  - setExcludedRules
```
public void setExcludedRules(Collection<WafExcludedRule> excludedRules)
```
    Rules to exclude from a rule group.
    
    Parameters:
    
    excludedRules - Rules to exclude from a rule group.
  - withExcludedRules
```
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.
    
    Parameters:
    
    excludedRules - Rules to exclude from a rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludedRules
```
public AwsWafWebAclRule withExcludedRules(Collection<WafExcludedRule> excludedRules)
```
    Rules to exclude from a rule group.
    
    Parameters:
    
    excludedRules - Rules to exclude from a rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverrideAction
```
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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule| OverrideAction.
    
    Parameters:
    
    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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule| OverrideAction.
  - getOverrideAction
```
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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule| OverrideAction.
    
    Returns:
    
    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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
  - withOverrideAction
```
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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule| OverrideAction.
    
    Parameters:
    
    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 WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule| OverrideAction.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
    
    Parameters:
    
    priority - Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
  - getPriority
```
public Integer getPriority()
```
    Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
    
    Returns:
    
    Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
  - withPriority
```
public AwsWafWebAclRule withPriority(Integer priority)
```
    Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
    
    Parameters:
    
    priority - Specifies the order in which the rules in a WebACL 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 WebACL, the values do not need to be consecutive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleId
```
public void setRuleId(String ruleId)
```
    The identifier for a rule.
    
    Parameters:
    
    ruleId - The identifier for a rule.
  - getRuleId
```
public String getRuleId()
```
    The identifier for a rule.
    
    Returns:
    
    The identifier for a rule.
  - withRuleId
```
public AwsWafWebAclRule withRuleId(String ruleId)
```
    The identifier for a rule.
    
    Parameters:
    
    ruleId - The identifier for a rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
    
    Parameters:
    
    type - The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
  - getType
```
public String getType()
```
    The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
    
    Returns:
    
    The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
  - withType
```
public AwsWafWebAclRule withType(String type)
```
    The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
    
    Parameters:
    
    type - The rule type.
    
    Valid values: REGULAR | RATE_BASED | GROUP
    
    The default is REGULAR.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsWafWebAclRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AwsWafWebAclRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsWafWebAclRule

Method Detail

setAction

getAction

withAction

getExcludedRules

setExcludedRules

withExcludedRules

withExcludedRules

setOverrideAction

getOverrideAction

withOverrideAction

setPriority

getPriority

withPriority

setRuleId

getRuleId

withRuleId

setType

getType

withType

toString

equals

hashCode

clone

marshall