Kong · Schema

VirtualCluster

A representation of a Kafka cluster that maps to a backend cluster.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The unique identifier of the virtual cluster.
description	string	A human-readable description of the virtual cluster.
destination	object
authentication	object
namespace	object
topic_aliases	array	Pre-release Feature This feature is currently in beta and is subject to change. Topic aliases allow exposing backend topics under additional names. An alias creates a new entry point to the same p
name	object
dns_label	object
acl_mode	object
labels	object
created_at	object
updated_at	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualCluster",
  "title": "VirtualCluster",
  "description": "A representation of a Kafka cluster that maps to a backend cluster.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier of the virtual cluster.",
      "type": "string",
      "format": "uuid",
      "x-speakeasy-param-suppress-computed-diff": true
    },
    "description": {
      "description": "A human-readable description of the virtual cluster.",
      "type": "string",
      "default": "",
      "maxLength": 512
    },
    "destination": {
      "$ref": "#/components/schemas/BackendClusterReference"
    },
    "authentication": {
      "$ref": "#/components/schemas/VirtualClusterAuthenticationSensitiveDataAwareSchemes"
    },
    "namespace": {
      "$ref": "#/components/schemas/VirtualClusterNamespace"
    },
    "topic_aliases": {
      "description": "**Pre-release Feature**\nThis feature is currently in beta and is subject to change.\n\nTopic aliases allow exposing backend topics under additional names.\nAn alias creates a new entry point to the same physical data.\nThe alias `topic` field references namespace-visible names (if namespace is configured).\nAliases are independent of namespace and can be used without it.\n\n**Requires a minimum runtime version of `1.2`**.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VirtualClusterTopicAlias"
      },
      "x-min-runtime-version": "1.2"
    },
    "name": {
      "$ref": "#/components/schemas/VirtualClusterName"
    },
    "dns_label": {
      "$ref": "#/components/schemas/VirtualClusterDNSLabel"
    },
    "acl_mode": {
      "$ref": "#/components/schemas/VirtualClusterACLMode"
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "dns_label",
    "destination",
    "authentication",
    "acl_mode",
    "created_at",
    "updated_at"
  ]
}