EventGatewayListenerPolicyCreate

The typed schema of the listener policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:tls_server

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

EventGatewayListenerPolicyUpdate

The typed schema of the listener policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:tls_server

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

EventGatewayPolicyPatch

The schema of the policy to patch it.

namestring

A unique user-defined name of the policy.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the policy.

<= 512 characters

enabledboolean

Whether the policy is enabled.

conditionstring

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

<= 1000 characters

Example:context.topic.name.endsWith('my_suffix')

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

EventGatewayListenerPolicyPatch

The schema of the policy to patch it.

namestring

A unique user-defined name of the policy.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the policy.

<= 512 characters

enabledboolean

Whether the policy is enabled.

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

TLSVersionRange

object

A range of TLS versions.

Default:{"min":"TLSv1.2","max":"TLSv1.3"}

minstring

Minimum TLS version to use.

Allowed values:TLSv1.2TLSv1.3

Default:TLSv1.2

maxstring

Maximum TLS version to use.

Allowed values:TLSv1.2TLSv1.3

Default:TLSv1.3

Example