ServerlessCreateDataPlaneGroup

object
* Additional properties are NOT allowed.
regionstringrequired

Region to deploy serverless gateways to.

Example:us

Example

CreateCloudGatewayConfigurationServerlessV1DataplaneGroup

object

Object that describes where to deploy a serverless v1 gateway, along with how many instances.

* Additional properties are NOT allowed.
providerstringrequired

Name of cloud provider.

Allowed values:aws

Example:aws

regionstringrequired

Region of cloud provider to deploy serverless v1 gateways 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
Example

Base Create Configuration Request

object
kindstringrequired

Provisioning backend to use for deploying data-plane groups.

Allowed values:dedicated.v0serverless.v0serverless.v1

control_plane_idstring(uuid)required

ID of the control-plane this 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

DedicatedCreateConfigurationRequest

object
kindstringrequired

Provisioning backend to use for deploying data-plane groups.

Allowed values:dedicated.v0

control_plane_idstring(uuid)required

ID of the control-plane this 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 to configure data-plane groups with.

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

Example:3.2

dataplane_groupsarray[object]required

Object that describes where to deploy a dedicated gateway, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
api_accessstring

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

Allowed values:privateprivate+publicpublic

Default:private+public

Example

ServerlessCreateConfigurationRequest

object
kindstringrequired

Provisioning backend to use for deploying data-plane groups.

Allowed values:serverless.v0

control_plane_idstring(uuid)required

ID of the control-plane this 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_groupsarray[object]required

List of data-plane groups that describe where to deploy serverless instances, along with how many
instances. As part of serverless business logic, the max number of data-plane groups a serverless
configuration can have is 1.

<= 1 characters

* Additional properties are NOT allowed.
Show Child Parameters
Example