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

Base Configuration

object
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:dedicated.v0serverless.v0serverless.v1

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

Example

Dedicated Configuration

object
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:dedicated.v0

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

versionstringrequired

Gateway version the gateway configuration targets.

Match pattern:^(\d)+(\.(\d)+)?$

Example:3.2

api_accessstring

Type of API access dataplane groups will support for a configuration.

Allowed values:privateprivate+publicpublic

Default: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]required

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

Show Child Parameters
entity_versionnumberrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

Example

Serverless Configuration

object
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:serverless.v0

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

dataplane_group_configarray[object]required

Object that describes where a serverless data-plane group will be deployed to.

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

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

Show Child Parameters
entity_versionnumberrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

Example