Kong · Schema

EventGatewayACLRule

A Kafka ACL rule to apply to virtual cluster traffic

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
resource_type string This rule applies to access only for type of resource
action string How to handle the request if the rule matches
operations array Types of Kafka operations to match against. Note that not every operation can apply to every resource type.
resource_names object If any of these entries match, the resource name matches for this rule. A maximum of 50 entries are allowed.
View JSON Schema on GitHub

JSON Schema

kong-eventgatewayaclrule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventGatewayACLRule",
  "title": "EventGatewayACLRule",
  "description": "A Kafka ACL rule to apply to virtual cluster traffic",
  "type": "object",
  "properties": {
    "resource_type": {
      "description": "This rule applies to access only for type of resource",
      "type": "string",
      "enum": [
        "topic",
        "group",
        "transactional_id",
        "cluster"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "action": {
      "description": "How to handle the request if the rule matches",
      "type": "string",
      "enum": [
        "allow",
        "deny"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "operations": {
      "description": "Types of Kafka operations to match against. Note that not every operation can apply to every resource type.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventGatewayACLOperation"
      }
    },
    "resource_names": {
      "description": "If any of these entries match, the resource name matches for this rule. A maximum of 50 entries are allowed.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/EventGatewayACLRuleResourceNamesStaticArray"
        },
        {
          "$ref": "#/components/schemas/EventGatewayACLRuleResourceNamesDynamicArray"
        }
      ]
    }
  },
  "required": [
    "resource_type",
    "action",
    "operations",
    "resource_names"
  ]
}