---
title: "Dedicated Data-Plane Group"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/53f44c10-7c5c-44ed-9e12-01aa08aa0a32/schemas/DedicatedDataPlaneGroup"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/53f44c10-7c5c-44ed-9e12-01aa08aa0a32.md

# Dedicated Data-Plane Group

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

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 3.0.0
servers:
  - url: https://global.api.konghq.com/v3
    description: Base URL for the global region
components:
  schemas:
    CloudGatewaysProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
    DataPlaneGroupAutoscale:
      oneOf:
        - $ref: "#/components/schemas/DataPlaneGroupAutoscaleStatic"
        - $ref: "#/components/schemas/DataPlaneGroupAutoscaleAutopilot"
    DataPlaneGroupEnvironmentConfigurations:
      description: Array of environment configurations for a data-plane group.
      type: array
      items:
        $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurationItem"
      title: Data-Plane Group Environment Configurations
    DataPlaneGroupAutoscaleStatic:
      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.
      type: object
      properties:
        kind:
          type: string
          enum:
            - static
        instance_type:
          $ref: "#/components/schemas/CloudGatewaysInstanceTypeName"
        requested_instances:
          description: Number of cloud gateways the deployment target will contain.
          type: integer
          example: 3
      additionalProperties: false
      deprecated: true
      required:
        - kind
        - instance_type
        - requested_instances
      title: Data-Plane Group Autoscale Static
    DataPlaneGroupAutoscaleAutopilot:
      description: Object that describes the autopilot autoscaling strategy.
      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: Data-Plane Group Autoscale Autopilot
    DataPlaneGroupEnvironmentConfigurationItem:
      description: Object that describes the environment configurations for a
        data-plane group. Env names must be prefixed by KONG_.
      type: object
      properties:
        name:
          description: Name of environment variable. Only env names prefixed by KONG_ are
            allowed.
          type: string
          example: KONG_LOG_LEVEL
        value:
          description: Value assigned to the corresponding environment variable.
          type: string
          example: INFO
      additionalProperties: false
      required:
        - name
        - value
      title: Data-Plane Group Environment Configurations
    CloudGatewaysInstanceTypeName:
      description: Instance type name to indicate capacity.
      type: string
      enum:
        - small
        - medium
        - large
    DedicatedDataPlaneGroup:
      description: Object that describes the set of dedicated data-plane groups
        currently pointed to a configuration.
      type: object
      properties:
        id:
          description: ID of the dataplane group that represents this deployment target.
          type: string
          format: uuid
          example: 14a74117-868a-4859-bf6c-eb2fe301a6ab
        provider:
          $ref: "#/components/schemas/CloudGatewaysProviderName"
        region:
          description: Region of cloud provider the cloud gateways will be deployed to.
          type: string
          example: us-east-2
        autoscale:
          $ref: "#/components/schemas/DataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
        cloud_gateway_network_id:
          description: Network ID this dataplane group is attached to.
          type: string
          format: uuid
        state:
          description: State of the dataplane group.
          type: string
          enum:
            - created
            - initializing
            - ready
            - terminating
            - terminated
        state_metadata:
          description: >
            Metadata describing the backing state of the dataplane group and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the dataplane group from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the dataplane group may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Dataplane group could not be deployed due to insufficient cloud
                provider compute instances.
          readOnly: true
        private_ip_addresses:
          description: >
            List of private IP addresses of the internal load balancer that
            proxies traffic to this dataplane group.
          type: array
          items:
            type: string
        egress_ip_addresses:
          description: >
            List of egress IP addresses for the network that this dataplane
            group runs on.
          type: array
          items:
            type: string
        hostnames:
          description: List of hostnames for proxying to the data-plane group.
          type: array
          items:
            type: string
        created_at:
          description: An ISO-8604 timestamp representation of data-plane group creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An ISO-8604 timestamp representation of data-plane group update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - provider
        - region
        - autoscale
        - cloud_gateway_network_id
        - state
        - created_at
        - updated_at
      title: Dedicated Data-Plane Group
```
