Kong · Schema

ManagedCacheAddOnDataPlaneGroup

Object that describes a data-plane group where managed cache add-on is deployed.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string ID of the data-plane group.
cloud_gateway_network_id string Network ID this data-plane group is attached to.
provider object
region string Region of cloud provider the data-plane group is deployed to.
state string The current state of the managed cache add-on in the data-plane group. Possible values: - `initializing` - The add-on is in the process of being initialized/updated and is setting up necessary resourc
state_metadata object Metadata describing the state of the managed cache add-on in the data-plane group.
View JSON Schema on GitHub

JSON Schema

kong-managedcacheaddondataplanegroup-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ManagedCacheAddOnDataPlaneGroup",
  "title": "ManagedCacheAddOnDataPlaneGroup",
  "description": "Object that describes a data-plane group where managed cache add-on is deployed.",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the data-plane group.",
      "type": "string",
      "format": "uuid",
      "example": "1150820b-c69f-4a2a-b9be-bbcdbc5cd618"
    },
    "cloud_gateway_network_id": {
      "description": "Network ID this data-plane group is attached to.",
      "type": "string",
      "format": "uuid",
      "example": "36ae63d3-efd1-4bec-b246-62aa5d3f5695"
    },
    "provider": {
      "$ref": "#/components/schemas/ProviderName"
    },
    "region": {
      "description": "Region of cloud provider the data-plane group is deployed to.",
      "type": "string",
      "example": "us-east-1"
    },
    "state": {
      "description": "The current state of the managed cache add-on in the data-plane group. Possible values:\n- `initializing` - The add-on is in the process of being initialized/updated and is setting up necessary resources for this data-plane group.\n- `ready` - The add-on is fully operational for this data-plane group.\n- `error` - The add-on is in an error state, and is not operational for this data-plane group.\n- `terminating` - The add-on is in the process of being deleted for this data-plane group.\n",
      "type": "string",
      "enum": [
        "initializing",
        "ready",
        "error",
        "terminating"
      ],
      "readOnly": true,
      "x-speakeasy-unknown-values": "allow"
    },
    "state_metadata": {
      "description": "Metadata describing the state of the managed cache add-on in the data-plane group.\n",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error_reason": {
          "description": "Reason why the managed cache add-on may be in an error state, reported from backing infrastructure.\n",
          "type": "string",
          "example": "Failed to create managed cache add-on due to invalid configuration.\n"
        }
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "cloud_gateway_network_id",
    "provider",
    "region",
    "state",
    "state_metadata"
  ]
}