Configuration Autoscale Autopilot

object

Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.

* 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

Configuration Data-Plane Group Environment

array

Array of environment variables 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

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