Data-Plane Group Autoscale Autopilot

object

Object that describes the autopilot autoscaling strategy.

* Additional properties are NOT allowed.
kindstringrequired

Allowed values:autopilot

base_rpsintegerrequired

Base number of requests per second that the deployment target should support.

Example:1

max_rpsintegerDEPRECATED

Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps. This field is deprecated and shouldn’t be used in new configurations as it will be removed in a future version. max_rps is now calculated as 10x base_rps.

Example:1000

Example

Dedicated Data-Plane Group Configuration

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 of cloud provider the cloud gateways will be deployed to.

Example:us-east-2

cloud_gateway_network_idstring(uuid)required

Network ID this dataplane group is attached to.

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
Example

Serverless Data-Plane Group Configuration

object

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

* Additional properties are NOT allowed.
regionstringrequired

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

Example:us

Example

Serverless V1 Data-Plane Group Configuration

object

Object that describes where a serverless v1 data-plane group will be deployed to, 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 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
Example

Data-Plane Group Environment Configurations

array

Array of environment configurations for a data-plane group.

namestringrequired

Name of environment variable. Only env names prefixed by KONG_ are allowed.

Example:KONG_LOG_LEVEL

valuestringrequired

Value assigned to the corresponding environment variable.

Example:INFO