VirtualClusterDNSLabel

string

The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.
The format follows the RFC1035: 1-63 chars, lowercase alphanumeric or ‘-’, must start and end with an alphanumeric character.

Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

>= 1 characters<= 63 characters

Example

VirtualClusterACLMode

string

Configures whether or not ACL policies are enforced on the gateway.

  • enforce_on_gateway means the gateway enforces its own ACL policies for this virtual cluster
    and does not forward ACL-related commands to the backend cluster.
    Note that if there are no ACL policies configured, all access is denied.
  • passthrough tells the gateway to forward all ACL-related commands.

Allowed values:enforce_on_gatewaypassthrough

BackendCluster

object

The Kafka cluster.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The unique identifier of the backend cluster.

namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.

Default:false

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

BackendClusterName

string

The unique name of the backend cluster.

>= 1 characters<= 255 characters

BackendClusterReference

object

The backend cluster associated with the virtual cluster.

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the backend cluster.

namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

Example