Configuration Data-Plane Group Environment Field

object

Environment variable name and value to set for a data-plane group.

namestring(^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*)required

Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.

>= 6 characters<= 120 characters

Example:KONG_LOG_LEVEL

valuestringrequired

Value assigned to the environment variable field for the data-plane group.

>= 1 characters<= 120 characters

Example:info

Example

Configuration Data-Plane Group Config Item

object

Object that describes where a data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

cloud_gateway_network_idstring(uuid)

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

autoscaleOne Of
Configuration Autoscale StaticobjectDEPRECATED

Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version. For serverless.v1 kind of cloud gateways, this field should be omitted.

* Additional properties are NOT allowed.
Show Child Parameters
environmentarray[object]

Environment variable name and value to set for a data-plane group.

Show Child Parameters
Example

Cloud Gateway Configuration Data-Plane Group

object

Object that describes the set of data-plane groups currently pointed to this configuration.

idstring(uuid)requiredread-only

ID of the data-plane group that represents a deployment target for a set of data-planes.

Example:cbb8872a-1f83-4806-bf69-fdf0b4783c7e

providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

autoscaleOne Of
Configuration Autoscale StaticobjectDEPRECATED

Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version. For serverless.v1 kind of cloud gateways, this field should be omitted.

* Additional properties are NOT allowed.
Show Child Parameters
environmentarray[object]

Environment variable name and value to set for a data-plane group.

Show Child Parameters
cloud_gateway_network_idstring(uuid)

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

statestringrequired

State of the data-plane group.

Allowed values:createdinitializingreadyterminatingterminated

state_metadataobject

Metadata describing the backing state of the dataplane group and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
private_ip_addressesarray[string]

List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.

Example:192.168.248.132, 192.168.66.81, 192.168.137.135

egress_ip_addressesarray[string]

List of egress IP addresses for the network that this data-plane group runs on.

Example:71.78.149.75, 91.149.112.244, 51.235.15.121

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of data-plane group creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of data-plane group update date.

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

Example

Configuration

object

Object containing information about a control-plane’s cloud-gateways configuration.

idstring(uuid)requiredread-only

Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

versionstring

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

api_accessstring

Type of API access data-plane groups will support for a configuration.

Allowed values:privatepublicprivate+public

Default:private+public

Example:private+public

dataplane_group_configarray[object]required

Object that describes where a data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object](set)required

Object that describes the set of data-plane groups currently pointed to this configuration.

Show Child Parameters
kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration update date.

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

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

Example

ConfigurationKind

string

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0