Amazon Network Firewall · JSON Structure

Openapi Rule Group Structure

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.

Type: object Properties: 4 Required: 1

FirewallIntrusion DetectionNetwork SecurityVPC

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

Properties

RuleVariables ReferenceSets RulesSource StatefulRuleOptions

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-structure/openapi-rule-group-structure.json",
  "name": "RuleGroup",
  "description": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> <p>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. </p> <p>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. </p>",
  "type": "object",
  "properties": {
    "RuleVariables": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RuleVariables"
        },
        {
          "description": "Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups. "
        }
      ]
    },
    "ReferenceSets": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReferenceSets"
        },
        {
          "description": "The list of a rule group's reference sets."
        }
      ]
    },
    "RulesSource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RulesSource"
        },
        {
          "description": "The stateful rules or stateless rules for the rule group. "
        }
      ]
    },
    "StatefulRuleOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatefulRuleOptions"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "RulesSource"
  ]
}