EventGatewayListenerPort

One Of

VirtualCluster

object

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

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

The unique identifier of the virtual cluster.

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

destinationobjectrequired

The backend cluster associated with the virtual cluster.

* Additional properties are NOT allowed.
Show Child Parameters
authenticationOne Of
arrayrequired

How to handle authentication from clients.

It tries to authenticate with every rule sequentially one by one.
It succeeds on the first match, and fails if no rule matches.

>= 1 items

VirtualClusterAuthenticationAnonymousobject
Show Child Parameters
namespaceobject

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

Show Child Parameters
namestringrequired

The name of the virtual cluster.

>= 1 characters<= 255 characters

dns_labelstringrequired

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:vcluster-1

acl_modestringrequired

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

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

VirtualClusterName

string

The name of the virtual cluster.

>= 1 characters<= 255 characters

VirtualClusterReference

A reference to a virtual cluster.

Any Of
idstring(uuid)required

The unique identifier of the virtual cluster.

>= 1 characters

Example

VirtualClusterReferenceById

object

Reference a virtual cluster by its unique identifier.

idstring(uuid)required

The unique identifier of the virtual cluster.

>= 1 characters

Example