Kong · Schema

ManagedCacheAddOnConfigResponse

Configuration for managed cache add-on.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
kind string Type of add-on configuration.
capacity_config object
data_plane_groups array List of data-plane groups where the managed cache is deployed.
state_metadata object Metadata describing the state of the managed cache add-on.
View JSON Schema on GitHub

JSON Schema

kong-managedcacheaddonconfigresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ManagedCacheAddOnConfigResponse",
  "title": "ManagedCacheAddOnConfigResponse",
  "description": "Configuration for managed cache add-on.",
  "type": "object",
  "properties": {
    "kind": {
      "description": "Type of add-on configuration.",
      "type": "string",
      "const": "managed-cache.v0"
    },
    "capacity_config": {
      "$ref": "#/components/schemas/ManagedCacheCapacityConfig"
    },
    "data_plane_groups": {
      "description": "List of data-plane groups where the managed cache is deployed.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ManagedCacheAddOnDataPlaneGroup"
      }
    },
    "state_metadata": {
      "description": "Metadata describing the state of the managed cache add-on.\n",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cache_config_id": {
          "description": "Reference to cache configuration for this add-on.",
          "type": "string",
          "format": "uuid",
          "example": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471"
        },
        "cache_server_name": {
          "description": "Env vault path to cache server name.",
          "type": "string",
          "example": "{vault://env/ADDON_MANAGED_CACHE_SERVER_NAME}"
        },
        "cache_host": {
          "description": "Env vault path to cache hostname.",
          "type": "string",
          "example": "{vault://env/ADDON_MANAGED_CACHE_HOST}"
        },
        "cache_port": {
          "description": "Env vault path to cache port.",
          "type": "string",
          "example": "{vault://env/ADDON_MANAGED_CACHE_PORT}"
        },
        "cache_username": {
          "description": "Env vault path to cache username.",
          "type": "string",
          "example": "{vault://env/ADDON_MANAGED_CACHE_USERNAME}"
        },
        "cloud_authentication": {
          "description": "Metadata describing the cloud authentication details for managed cache add-on.\n",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "auth_provider": {
              "description": "Env vault path to cache auth provider.",
              "type": "string",
              "example": "{vault://env/ADDON_MANAGED_CACHE_AUTH_PROVIDER}"
            },
            "aws_cache_name": {
              "description": "Env vault path to aws cache name.",
              "type": "string",
              "example": "{vault://env/ADDON_MANAGED_CACHE_AWS_CACHE_NAME}"
            },
            "aws_region": {
              "description": "Env vault path to aws region.",
              "type": "string",
              "example": "{vault://env/ADDON_MANAGED_CACHE_AWS_REGION}"
            },
            "aws_assume_role_arn": {
              "description": "Env vault path to aws assume role arn.",
              "type": "string",
              "example": "{vault://env/ADDON_MANAGED_CACHE_AWS_ASSUME_ROLE_ARN}"
            },
            "azure_tenant_id": {
              "description": "Env vault path to azure tenant id.",
              "type": "string",
              "example": "{vault://env/ADDON_MANAGED_CACHE_AZURE_TENANT_ID}"
            }
          }
        }
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "kind",
    "capacity_config",
    "data_plane_groups",
    "state_metadata"
  ]
}