RuleGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.RuleGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroup()

Constructors
Constructor and Description
`RuleGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`Long`	`getCapacity()` The web ACL capacity units (WCUs) required for this rule group.
`String`	`getDescription()` A friendly description of the rule group.
`String`	`getId()` A unique identifier for the rule group.
`String`	`getName()` A friendly name of the rule group.
`List<Rule>`	`getRules()` The Rule statements used to identify the web requests that you want to allow, block, or count.
`VisibilityConfig`	`getVisibilityConfig()` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setCapacity(Long capacity)` The web ACL capacity units (WCUs) required for this rule group.
`void`	`setDescription(String description)` A friendly description of the rule group.
`void`	`setId(String id)` A unique identifier for the rule group.
`void`	`setName(String name)` A friendly name of the rule group.
`void`	`setRules(Collection<Rule> rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`void`	`setVisibilityConfig(VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`String`	`toString()` Returns a string representation of this object.
`RuleGroup`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`RuleGroup`	`withCapacity(Long capacity)` The web ACL capacity units (WCUs) required for this rule group.
`RuleGroup`	`withDescription(String description)` A friendly description of the rule group.
`RuleGroup`	`withId(String id)` A unique identifier for the rule group.
`RuleGroup`	`withName(String name)` A friendly name of the rule group.
`RuleGroup`	`withRules(Collection<Rule> rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`RuleGroup`	`withRules(Rule... rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`RuleGroup`	`withVisibilityConfig(VisibilityConfig visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.

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

- Constructor Detail
  - RuleGroup
```
public RuleGroup()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A friendly name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - A friendly name of the rule group. You cannot change the name of a rule group after you create it.
  - getName
```
public String getName()
```
    A friendly name of the rule group. You cannot change the name of a rule group after you create it.
    
    Returns:
    
    A friendly name of the rule group. You cannot change the name of a rule group after you create it.
  - withName
```
public RuleGroup withName(String name)
```
    A friendly name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - A friendly name of the rule group. You cannot change the name of a rule group after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - getId
```
public String getId()
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - withId
```
public RuleGroup withId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacity
```
public void setCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
  - getCapacity
```
public Long getCapacity()
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
    
    Returns:
    
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
  - withCapacity
```
public RuleGroup withCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
    
    When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
    
    AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public RuleGroup withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A friendly description of the rule group. You cannot change the description of a rule group after you create it.
    
    Parameters:
    
    description - A friendly description of the rule group. You cannot change the description of a rule group after you create it.
  - getDescription
```
public String getDescription()
```
    A friendly description of the rule group. You cannot change the description of a rule group after you create it.
    
    Returns:
    
    A friendly description of the rule group. You cannot change the description of a rule group after you create it.
  - withDescription
```
public RuleGroup withDescription(String description)
```
    A friendly description of the rule group. You cannot change the description of a rule group after you create it.
    
    Parameters:
    
    description - A friendly description of the rule group. You cannot change the description of a rule group after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<Rule> getRules()
```
    The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    Returns:
    
    The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
  - setRules
```
public void setRules(Collection<Rule> rules)
```
    The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    Parameters:
    
    rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
  - withRules
```
public RuleGroup withRules(Rule... rules)
```
    The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    NOTE: This method appends the values to the existing list (if any). Use setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public RuleGroup withRules(Collection<Rule> rules)
```
    The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    Parameters:
    
    rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibilityConfig
```
public void setVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - getVisibilityConfig
```
public VisibilityConfig getVisibilityConfig()
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Returns:
    
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
  - withVisibilityConfig
```
public RuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig)
```
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    Parameters:
    
    visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
    
    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 RuleGroup 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 RuleGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroup

Method Detail

setName

getName

withName

setId

getId

withId

setCapacity

getCapacity

withCapacity

setARN

getARN

withARN

setDescription

getDescription

withDescription

getRules

setRules

withRules

withRules

setVisibilityConfig

getVisibilityConfig

withVisibilityConfig

toString

equals

hashCode

clone

marshall