Encrypt
objectEncrypts Kafka records or keys using AES_256_GCM. Keys are therefore 256 bits long.
The type name of the policy.
Allowed values:encrypt
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The configuration of the policy.
Show Child Parameters
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"
EventGatewayEncryptConfig
objectThe configuration of the encrypt policy.
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 - encrypt the record key
- value - encrypt the record value
Allowed values:keyvalue
>= 1 items
One OfThe key to use for encryption.
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
Decrypt
objectDecrypts Kafka records or keys using AES_256_GCM. Keys are therefore 256 bits long.
The type name of the policy.
Allowed values:decrypt
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The configuration of the policy.
Show Child Parameters
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"
EventGatewayDecryptPolicyConfig
objectThe configuration of the decrypt policy.
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
One OfA 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
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.
Show Child Parameters
- key - decrypt the record key
- value - decrypt the record value
Allowed values:keyvalue
>= 1 items
Modify Headers
objectA policy that modifies headers for requests.
The type name of the policy.
Allowed values:modify_headers
>= 1 characters<= 255 characters
A unique user-defined name of the policy.
<= 255 characters
A human-readable description of the policy.
Default:
<= 512 characters
Whether the policy is enabled.
Default:true
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"}
The configuration of the modify headers policy.
Show Child Parameters
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"