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

Decrypt

object

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

typestringrequired

The type name of the policy.

Allowed values:decrypt

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

EventGatewayDecryptPolicyConfig

object

The configuration of the decrypt 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

key_sourcesOne Of
arrayrequired

A key source that describes how to find a symmetric key for encryption or decryption.
It can be an AWS KMS key source that uses a KMS to find a symmetric key,
or a static key source that uses a static symmetric key provided as secrets.

>= 1 items

EventGatewayAWSKeySourceobject

A key source that uses an AWS KMS to find a symmetric key. Load KMS credentials from the environment.

See aws docs
for more information about how credential retrieval.

* Additional properties are NOT allowed.
Show Child Parameters
part_of_recordarray[string]required
  • key - decrypt the record key
  • value - decrypt the record value

Allowed values:keyvalue

>= 1 items

Example