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.

FirewallIntrusion DetectionNetwork SecurityVPC

Properties

Name Type Description
RuleVariables object
ReferenceSets object
RulesSource object
StatefulRuleOptions object
View JSON Schema on GitHub

JSON Schema

openapi-rule-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/json-schema/openapi-rule-group-schema.json",
  "title": "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"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/openapi-rule-group"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.