Amazon Network Firewall · JSON Structure

Openapi Rules Source Structure

The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.

Type: object Properties: 4
FirewallIntrusion DetectionNetwork SecurityVPC

RulesSource is a JSON Structure definition published by Amazon Network Firewall, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

RulesString RulesSourceList StatefulRules StatelessRulesAndCustomActions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-structure/openapi-rules-source-structure.json",
  "name": "RulesSource",
  "description": "The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single <code>RulesSource</code>. You can use an instance of this for either stateless rules or stateful rules. ",
  "type": "object",
  "properties": {
    "RulesString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RulesString"
        },
        {
          "description": "<p>Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS 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>"
        }
      ]
    },
    "RulesSourceList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RulesSourceList"
        },
        {
          "description": "Stateful inspection criteria for a domain list rule group. "
        }
      ]
    },
    "StatefulRules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatefulRules"
        },
        {
          "description": "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.iorules/intro.html#\">Rules Format</a>. "
        }
      ]
    },
    "StatelessRulesAndCustomActions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatelessRulesAndCustomActions"
        },
        {
          "description": "Stateless inspection criteria to be used in a stateless rule group. "
        }
      ]
    }
  }
}