EventGatewayProducePolicyCreate

The typed schema of the produce policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:modify_headers

>= 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 modify headers policy.

Show Child Parameters
conditionstring

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

When the policy is applied as a child policy of schema_validation, the expression can also reference
record.value fields.

Default:

<= 1000 characters

Example:record.value.content.foo.bar == "a-value"

parent_policy_idstring(uuid)

The unique identifier of the parent schema validation policy, if any.

Example

EventGatewayProducePolicyUpdate

The typed schema of the produce policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:schema_validation

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

configOne Of
objectrequired

The configuration of the policy.

EventGatewayProduceSchemaValidationPolicySchemaRegistryConfigobject

The configuration of the produce schema validation policy when using a schema registry.

Show Child Parameters
conditionstring

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

Default:

<= 1000 characters

Example:context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"

Example

EventGatewayClusterPolicyModify

The typed schema of the cluster policy to modify it.

One Of
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

Encrypt

object

Encrypts Kafka records or keys using AES_256_GCM. Keys are therefore 256 bits long.

typestringrequired

The type name of the policy.

Allowed values:encrypt

>= 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.topic.name.endsWith("my_suffix") && record.headers["x-flag"] == "a-value"

Example

EventGatewayEncryptConfig

object

The configuration of the encrypt policy.

failure_modestringrequired

Describes how to handle failing encryption or decryption.
Use error if the record should be rejected if encryption or decryption fails.
Use passthrough to ignore encryption or decryption failure and continue proxying the record.

Allowed values:errorpassthrough

part_of_recordarray[string]required
  • key - encrypt the record key
  • value - encrypt the record value

Allowed values:keyvalue

>= 1 items

encryption_keyOne Of
required

The key to use for encryption.

EncryptionKeyAWSobject

The AWS KMS key to use for encryption.

Example:{"type":"aws","arn":"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"}

Show Child Parameters
Example