SchemaValidationType

string

How to validate the schema and parse the record.

  • confluent_schema_registry - validates against confluent schema registry.
  • json - simple JSON parsing without the schema.

Allowed values:confluent_schema_registryjson

SchemaRegistryCreate

The typed schema of the schema registry to create it.

One Of
namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

Allowed values:confluent

configobjectrequired

The configuration of the schema registry.

Show Child Parameters
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"}

Example

SchemaRegistryUpdate

The typed schema of the schema registry to modify it.

One Of
namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

Allowed values:confluent

configobjectrequired

The configuration of the schema registry.

Show Child Parameters
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"}

Example

EventGatewayPolicy

object

A policy associated with an Event Gateway.

typestringrequired

The type name of the policy.

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

idstring(uuid)required

The unique identifier of the policy.

configobject

The configuration of the policy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

parent_policy_idstring(uuid)

The unique identifier of the parent policy, if any.

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

conditionstring

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

Default:

<= 1000 characters

Example

EventGatewayListenerPolicy

object

A policy associated with an Event Gateway.

typestringrequired

The type name of the policy.

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

idstring(uuid)required

The unique identifier of the policy.

configobjectrequired

The configuration of the policy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

parent_policy_idstring(uuid)

The unique identifier of the parent policy, if any.

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

Example