---
title: "Configuration Data-Plane Group Config Item"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/schemas/ConfigurationDataPlaneGroupConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# Configuration Data-Plane Group Config Item

Object that describes where a data-plane group will be deployed to, along with how many instances.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
components:
  schemas:
    ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
      title: Provider Name
    ProviderRegionId:
      description: Region ID for cloud provider region.
      type: string
      example: us-east-2
      title: Provider Region ID
    NetworkId:
      description: The network ID to operate on. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      format: uuid
      example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
    ConfigurationDataPlaneGroupAutoscale:
      oneOf:
        - $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscaleStatic"
        - $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscaleAutopilot"
    ConfigurationDataPlaneGroupEnvironment:
      description: Array of environment variables to set for a data-plane group.
      type: array
      items:
        $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironmentField"
      title: Configuration Data-Plane Group Environment
    ConfigurationDataPlaneGroupAutoscaleStatic:
      description: 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.
      type: object
      properties:
        kind:
          type: string
          enum:
            - static
        instance_type:
          $ref: "#/components/schemas/InstanceTypeName"
        requested_instances:
          description: Number of data-planes the deployment target will contain.
          type: integer
          example: 3
      additionalProperties: false
      deprecated: true
      required:
        - kind
        - instance_type
        - requested_instances
      title: Configuration Autoscale Static
    ConfigurationDataPlaneGroupAutoscaleAutopilot:
      description: Object that describes the autopilot autoscaling strategy. For
        serverless.v1 kind of cloud gateways, this field should be omitted.
      type: object
      properties:
        kind:
          type: string
          enum:
            - autopilot
        base_rps:
          description: Base number of requests per second that the deployment target
            should support.
          type: integer
          example: 1
        max_rps:
          description: 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.
          type: integer
          example: 1000
          deprecated: true
      additionalProperties: false
      required:
        - kind
        - base_rps
      title: Configuration Autoscale Autopilot
    ConfigurationDataPlaneGroupEnvironmentField:
      description: Environment variable name and value to set for a data-plane group.
      type: object
      properties:
        name:
          description: >
            Name of the environment variable field to set for the data-plane
            group. Must be prefixed by KONG_.
          type: string
          format: ^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*
          example: KONG_LOG_LEVEL
          maxLength: 120
          minLength: 6
        value:
          description: Value assigned to the environment variable field for the data-plane
            group.
          type: string
          example: info
          maxLength: 120
          minLength: 1
      required:
        - name
        - value
      title: Configuration Data-Plane Group Environment Field
    InstanceTypeName:
      description: Instance type name to indicate capacity.
      type: string
      enum:
        - small
        - medium
        - large
    ConfigurationDataPlaneGroupConfig:
      description: Object that describes where a data-plane group will be deployed to,
        along with how many instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/ProviderName"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        cloud_gateway_network_id:
          $ref: "#/components/schemas/NetworkId"
        autoscale:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironment"
      additionalProperties: false
      required:
        - provider
        - region
      title: Configuration Data-Plane Group Config Item
```
