Kong · Schema

Cloud Gateway Configuration Data-Plane Group

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

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name	Type	Description
id	object
provider	object
region	object
autoscale	object
environment	object
cloud_gateway_network_id	object
state	string	State of the data-plane group.
state_metadata	object	Metadata describing the backing state of the dataplane group and why it may be in an erroneous state.
private_ip_addresses	array	List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
egress_ip_addresses	array	List of egress IP addresses for the network that this data-plane group runs on.
created_at	string	An RFC-3339 timestamp representation of data-plane group creation date.
updated_at	string	An RFC-3339 timestamp representation of data-plane group update date.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConfigurationDataPlaneGroup",
  "title": "Cloud Gateway Configuration Data-Plane Group",
  "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"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "state_metadata": {
      "description": "Metadata describing the backing state of the dataplane group and why it may be in an erroneous state.\n",
      "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.\n",
          "type": "string",
          "example": "Dataplane group could not be deployed due to insufficient cloud provider compute instances.\n"
        }
      },
      "x-speakeasy-terraform-ignore": true
    },
    "private_ip_addresses": {
      "description": "List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.\n",
      "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.\n",
      "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"
  ]
}