ACL

object

Apply Kafka ACLs to virtual cluster traffic.

typestringrequired

The type name of the policy.

Allowed values:acls

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

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"}

configobjectrequired

The configuration of the policy.

Show Child Parameters
conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Default:

<= 1000 characters

Example:context.auth.principal.name == "this-user"

Example

EventGatewayACLPolicyConfig

object

Apply ACLs to virtual cluster traffic.

rulesarray[object]required

A Kafka ACL rule to apply to virtual cluster traffic

>= 1 items

Show Child Parameters
Example

EventGatewayACLRule

object

A Kafka ACL rule to apply to virtual cluster traffic

resource_typestringrequired

This rule applies to access only for type of resource

Allowed values:topicgrouptransactional_idcluster

actionstringrequired

How to handle the request if the rule matches

Allowed values:allowdeny

operationsarray[object]required

An Event Gateway operation to match against in an ACL rule.

Show Child Parameters
resource_namesOne Of
required

If any of these entries match, the resource name matches for this rule. A maximum of 50 entries are allowed.

EventGatewayACLResourceNamearray[object]

An Event Gateway resource name to match against in an ACL rule.

<= 50 items

Example:{"match":"orders-*"}{"match":"payments-*"}

Show Child Parameters
Example

EventGatewayACLOperation

object

An Event Gateway operation to match against in an ACL rule.

namestringrequired

Allowed values:allalteralter_configscreatedeletedescribedescribe_configsidempotent_writereadwrite

Example

EventGatewayACLResourceName

object

An Event Gateway resource name to match against in an ACL rule.

matchstring(glob)required

Currently supported are exact matches and globs.
All * characters are interpreted as globs, i.e. they match zero or more of any character.

Example