StatefulRule (AWS Java SDK for AWS Network Firewall 1.12.772 API)

java.lang.Object
- com.amazonaws.services.networkfirewall.model.StatefulRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StatefulRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StatefulRule()

Constructors
Constructor and Description
`StatefulRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StatefulRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
`Header`	`getHeader()` The stateful inspection criteria for this rule, used to inspect traffic flows.
`List<RuleOption>`	`getRuleOptions()` Additional options for the rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAction(String action)` Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
`void`	`setHeader(Header header)` The stateful inspection criteria for this rule, used to inspect traffic flows.
`void`	`setRuleOptions(Collection<RuleOption> ruleOptions)` Additional options for the rule.
`String`	`toString()` Returns a string representation of this object.
`StatefulRule`	`withAction(StatefulAction action)` Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
`StatefulRule`	`withAction(String action)` Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
`StatefulRule`	`withHeader(Header header)` The stateful inspection criteria for this rule, used to inspect traffic flows.
`StatefulRule`	`withRuleOptions(Collection<RuleOption> ruleOptions)` Additional options for the rule.
`StatefulRule`	`withRuleOptions(RuleOption... ruleOptions)` Additional options for the rule.

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

- Constructor Detail
  - StatefulRule
```
public StatefulRule()
```
- Method Detail
  - setAction
```
public void setAction(String action)
```
    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    - PASS - Permits the packets to go to the intended destination.
    - DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    - ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
      
      You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    - REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Parameters:
    action - Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    
    PASS - Permits the packets to go to the intended destination.
    
    DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    
    REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    See Also:
    
    StatefulAction
  - getAction
```
public String getAction()
```
    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    - PASS - Permits the packets to go to the intended destination.
    - DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    - ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
      
      You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    - REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Returns:
    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    
    PASS - Permits the packets to go to the intended destination.
    
    DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    
    REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    See Also:
    
    StatefulAction
  - withAction
```
public StatefulRule withAction(String action)
```
    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    - PASS - Permits the packets to go to the intended destination.
    - DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    - ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
      
      You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    - REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Parameters:
    action - Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    
    PASS - Permits the packets to go to the intended destination.
    
    DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    
    REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatefulAction
  - withAction
```
public StatefulRule withAction(StatefulAction action)
```
    Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    - PASS - Permits the packets to go to the intended destination.
    - DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    - ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
      
      You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    - REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Parameters:
    action - Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
    
    The actions for a stateful rule are defined as follows:
    
    PASS - Permits the packets to go to the intended destination.
    
    DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
    
    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
    
    REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatefulAction
  - setHeader
```
public void setHeader(Header header)
```
    The stateful inspection criteria for this rule, used to inspect traffic flows.
    
    Parameters:
    
    header - The stateful inspection criteria for this rule, used to inspect traffic flows.
  - getHeader
```
public Header getHeader()
```
    The stateful inspection criteria for this rule, used to inspect traffic flows.
    
    Returns:
    
    The stateful inspection criteria for this rule, used to inspect traffic flows.
  - withHeader
```
public StatefulRule withHeader(Header header)
```
    The stateful inspection criteria for this rule, used to inspect traffic flows.
    
    Parameters:
    
    header - The stateful inspection criteria for this rule, used to inspect traffic flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRuleOptions
```
public List<RuleOption> getRuleOptions()
```
    Additional options for the rule. These are the Suricata RuleOptions settings.
    
    Returns:
    
    Additional options for the rule. These are the Suricata RuleOptions settings.
  - setRuleOptions
```
public void setRuleOptions(Collection<RuleOption> ruleOptions)
```
    Additional options for the rule. These are the Suricata RuleOptions settings.
    
    Parameters:
    
    ruleOptions - Additional options for the rule. These are the Suricata RuleOptions settings.
  - withRuleOptions
```
public StatefulRule withRuleOptions(RuleOption... ruleOptions)
```
    Additional options for the rule. These are the Suricata RuleOptions settings.
    
    NOTE: This method appends the values to the existing list (if any). Use setRuleOptions(java.util.Collection) or withRuleOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ruleOptions - Additional options for the rule. These are the Suricata RuleOptions settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRuleOptions
```
public StatefulRule withRuleOptions(Collection<RuleOption> ruleOptions)
```
    Additional options for the rule. These are the Suricata RuleOptions settings.
    
    Parameters:
    
    ruleOptions - Additional options for the rule. These are the Suricata RuleOptions 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 StatefulRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class StatefulRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StatefulRule

Method Detail

setAction

getAction

withAction

withAction

setHeader

getHeader

withHeader

getRuleOptions

setRuleOptions

withRuleOptions

withRuleOptions

toString

equals

hashCode

clone

marshall