Skip to content

RulesSource

Source code in docs_src/capo_network_firewall/types/rules_source.py
class RulesSource(TypedDict, closed=True):
    rules_string: NotRequired["capo_network_firewall.types.rules_string.RulesString"]
    """<p>Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.</p> <p>These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.</p> <note> <p>You can't use the <code>priority</code> keyword if the <code>RuleOrder</code> option in <a>StatefulRuleOptions</a> is set to <code>STRICT_ORDER</code>.</p> </note>"""
    rules_source_list: NotRequired[
        "capo_network_firewall.types.rules_source_list.RulesSourceList"
    ]
    """<p>Stateful inspection criteria for a domain list rule group. </p>"""
    stateful_rules: NotRequired[
        "capo_network_firewall.types.stateful_rules.StatefulRules"
    ]
    """<p>An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href="https://suricata.readthedocs.io/en/suricata-7.0.8/rules/intro.html">Rules Format</a>. </p>"""
    stateless_rules_and_custom_actions: NotRequired[
        "capo_network_firewall.types.stateless_rules_and_custom_actions.StatelessRulesAndCustomActions"
    ]
    """<p>Stateless inspection criteria to be used in a stateless rule group. </p>"""

rules_source_list instance-attribute

rules_source_list: NotRequired[RulesSourceList]

Stateful inspection criteria for a domain list rule group.

rules_string instance-attribute

rules_string: NotRequired[RulesString]

Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.

These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.

stateful_rules instance-attribute

stateful_rules: NotRequired[StatefulRules]

An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

stateless_rules_and_custom_actions instance-attribute

stateless_rules_and_custom_actions: NotRequired[StatelessRulesAndCustomActions]

Stateless inspection criteria to be used in a stateless rule group.