Dedicated Data-Plane Group

object

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

idstring(uuid)required

ID of the dataplane group that represents this deployment target.

Example:14a74117-868a-4859-bf6c-eb2fe301a6ab

providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region of cloud provider the cloud gateways will be deployed to.

Example:us-east-2

autoscaleOne Of
required
Data-Plane Group 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.

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

Object that describes the environment configurations for a data-plane group. Env names must be prefixed by KONG_.

* Additional properties are NOT allowed.
Show Child Parameters
cloud_gateway_network_idstring(uuid)required

Network ID this dataplane group is attached to.

statestringrequired

State of the dataplane group.

Allowed values:createdinitializingreadyterminatingterminated

state_metadataobjectread-only

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 dataplane group.

egress_ip_addressesarray[string]

List of egress IP addresses for the network that this dataplane group runs on.

hostnamesarray[string]

List of hostnames for proxying to the data-plane group.

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group update date.

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

Example

Serverless Data-Plane Groups Configuration

array

Object that describes where serverless gateways will be deployed to, along with how many instances.

regionstringrequired

Region of cloud provider the cloud gateways will be deployed to.

Example:us

Serverless V1 Data-Plane Groups Configuration

array

Object that describes where serverless v1 data-plane groups will be deployed to, along with how many instances.

providerstringrequired

Name of cloud provider.

Allowed values:aws

Example:aws

regionstringrequired

Region of cloud provider the serverless v1 gateways will be deployed to.

Example:us

environmentarray[object]

Object that describes the environment configurations for a data-plane group. Env names must be prefixed by KONG_.

* Additional properties are NOT allowed.
Show Child Parameters

Serverless Data-Plane Group

object

Object that describes a serverless data-plane group, deployed for a control-plane.

idstring(uuid)required

ID of the data-plane group that represents the deployment target.

Example:14a74117-868a-4859-bf6c-eb2fe301a6ab

regionstringrequired

Serverless region the gateway will be deployed to.

Example:us

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
hostnamesarray[string]

List of hostnames for proxying to the serverless data-plane group.

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group update date.

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

Example

Serverless V1 Data-Plane Group

object

Object that describes a serverless v1 data-plane group, deployed for a control-plane.

idstring(uuid)required

ID of the serverless v1 dataplane group that represents this deployment target.

Example:14a74117-868a-4859-bf6c-eb2fe301a6ab

providerstringrequired

Name of cloud provider.

Allowed values:aws

Example:aws

regionstringrequired

Region of cloud provider the serverless v1 gateways will be deployed to.

Example:us

environmentarray[object]

Object that describes the environment configurations for a data-plane group. Env names must be prefixed by KONG_.

* Additional properties are NOT allowed.
Show Child Parameters
statestringrequired

State of the dataplane group.

Allowed values:createdinitializingreadyterminatingterminated

private_ip_addressesarray[string]

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

egress_ip_addressesarray[string]

List of egress IP addresses for the network that this dataplane group runs on.

hostnamesarray[string]

List of hostnames for proxying to the data-plane group.

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of data-plane group update date.

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

Example