RuleGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.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
```
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

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)`
`ReferenceSets`	`getReferenceSets()` The list of a rule group's reference sets.
`RulesSource`	`getRulesSource()` The stateful rules or stateless rules for the rule group.
`RuleVariables`	`getRuleVariables()` Settings that are available for use in the rules in the rule group.
`StatefulRuleOptions`	`getStatefulRuleOptions()` Additional options governing how Network Firewall handles stateful rules.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setReferenceSets(ReferenceSets referenceSets)` The list of a rule group's reference sets.
`void`	`setRulesSource(RulesSource rulesSource)` The stateful rules or stateless rules for the rule group.
`void`	`setRuleVariables(RuleVariables ruleVariables)` Settings that are available for use in the rules in the rule group.
`void`	`setStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)` Additional options governing how Network Firewall handles stateful rules.
`String`	`toString()` Returns a string representation of this object.
`RuleGroup`	`withReferenceSets(ReferenceSets referenceSets)` The list of a rule group's reference sets.
`RuleGroup`	`withRulesSource(RulesSource rulesSource)` The stateful rules or stateless rules for the rule group.
`RuleGroup`	`withRuleVariables(RuleVariables ruleVariables)` Settings that are available for use in the rules in the rule group.
`RuleGroup`	`withStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)` Additional options governing how Network Firewall handles stateful rules.

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

- Constructor Detail
  - RuleGroup
```
public RuleGroup()
```
- Method Detail
  - setRuleVariables
```
public void setRuleVariables(RuleVariables ruleVariables)
```
    Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
    
    Parameters:
    
    ruleVariables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
  - getRuleVariables
```
public RuleVariables getRuleVariables()
```
    Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
    
    Returns:
    
    Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
  - withRuleVariables
```
public RuleGroup withRuleVariables(RuleVariables ruleVariables)
```
    Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
    
    Parameters:
    
    ruleVariables - Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReferenceSets
```
public void setReferenceSets(ReferenceSets referenceSets)
```
    The list of a rule group's reference sets.
    
    Parameters:
    
    referenceSets - The list of a rule group's reference sets.
  - getReferenceSets
```
public ReferenceSets getReferenceSets()
```
    The list of a rule group's reference sets.
    
    Returns:
    
    The list of a rule group's reference sets.
  - withReferenceSets
```
public RuleGroup withReferenceSets(ReferenceSets referenceSets)
```
    The list of a rule group's reference sets.
    
    Parameters:
    
    referenceSets - The list of a rule group's reference sets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRulesSource
```
public void setRulesSource(RulesSource rulesSource)
```
    The stateful rules or stateless rules for the rule group.
    
    Parameters:
    
    rulesSource - The stateful rules or stateless rules for the rule group.
  - getRulesSource
```
public RulesSource getRulesSource()
```
    The stateful rules or stateless rules for the rule group.
    
    Returns:
    
    The stateful rules or stateless rules for the rule group.
  - withRulesSource
```
public RuleGroup withRulesSource(RulesSource rulesSource)
```
    The stateful rules or stateless rules for the rule group.
    
    Parameters:
    
    rulesSource - The stateful rules or stateless rules for the rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatefulRuleOptions
```
public void setStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)
```
    Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
    
    Parameters:
    
    statefulRuleOptions - Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
  - getStatefulRuleOptions
```
public StatefulRuleOptions getStatefulRuleOptions()
```
    Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
    
    Returns:
    
    Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
  - withStatefulRuleOptions
```
public RuleGroup withStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions)
```
    Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
    
    Parameters:
    
    statefulRuleOptions - Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.
    
    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

setRuleVariables

getRuleVariables

withRuleVariables

setReferenceSets

getReferenceSets

withReferenceSets

setRulesSource

getRulesSource

withRulesSource

setStatefulRuleOptions

getStatefulRuleOptions

withStatefulRuleOptions

toString

equals

hashCode

clone

marshall