Package software.amazon.awssdk.services.networkfirewall.model

Class StatefulRule

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.StatefulRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StatefulRule.Builder,StatefulRule>
@Generated("software.amazon.awssdk:codegen") public final class StatefulRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StatefulRule.Builder,StatefulRule>

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:

  • Method Details

    • action

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, action will return StatefulAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      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:

    • actionAsString

      public final String actionAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, action will return StatefulAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      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:

    • header

      public final Header header()

      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.

    • hasRuleOptions

      public final boolean hasRuleOptions()
      For responses, this returns true if the service returned a value for the RuleOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • ruleOptions

      public final List<RuleOption> ruleOptions()

      Additional options for the rule. These are the Suricata RuleOptions settings.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuleOptions() method.

      Returns:
      Additional options for the rule. These are the Suricata RuleOptions settings.

    • toBuilder

      public StatefulRule.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StatefulRule.Builder,StatefulRule>
      Returns:
      a builder for type T

    • builder

      public static StatefulRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StatefulRule.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.