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

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

# Cloud Gateway Configuration Data-Plane Group

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

## 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:
    DataPlaneGroupId:
      description: ID of the data-plane group that represents a deployment target for
        a set of data-planes.
      type: string
      format: uuid
      example: cbb8872a-1f83-4806-bf69-fdf0b4783c7e
      readOnly: true
    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
    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
    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
    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
    ConfigurationDataPlaneGroup:
      description: Object that describes the set of data-plane groups currently
        pointed to this configuration.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/DataPlaneGroupId"
        provider:
          $ref: "#/components/schemas/ProviderName"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        autoscale:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironment"
        cloud_gateway_network_id:
          $ref: "#/components/schemas/NetworkId"
        state:
          description: State of the data-plane 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.
        private_ip_addresses:
          description: >
            List of private IP addresses of the internal load balancer that
            proxies traffic to this data-plane group.
          type: array
          items:
            type: string
          example:
            - 192.168.248.132
            - 192.168.66.81
            - 192.168.137.135
        egress_ip_addresses:
          description: >
            List of egress IP addresses for the network that this data-plane
            group runs on.
          type: array
          items:
            type: string
          example:
            - 71.78.149.75
            - 91.149.112.244
            - 51.235.15.121
        created_at:
          description: An RFC-3339 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 RFC-3339 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
        - state
        - created_at
        - updated_at
      title: Cloud Gateway Configuration Data-Plane Group
```
