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

Class RuleGroup

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<RuleGroup.Builder,​RuleGroup>
    @Generated("software.amazon.awssdk:codegen")
public final class RuleGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleGroup.Builder,​RuleGroup>

    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:
    Serialized Form

    • Method Detail

      • ruleVariables

        public final RuleVariables ruleVariables()

        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.

      • referenceSets

        public final ReferenceSets referenceSets()

        The list of a rule group's reference sets.

        Returns:
        The list of a rule group's reference sets.

      • rulesSource

        public final RulesSource rulesSource()

        The stateful rules or stateless rules for the rule group.

        Returns:
        The stateful rules or stateless rules for the rule group.

      • statefulRuleOptions

        public final 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. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.

        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. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.

      • hashCode

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

      • equals

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

      • 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)