Amazon MSK · JSON Structure

Msk Api Provisioned Structure

Provisioned cluster.

Type: object Properties: 11 Required: 2
BroadcastingMedia ProcessingMedia

Provisioned is a JSON Structure definition published by Amazon MSK, describing 11 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

BrokerNodeGroupInfo CurrentBrokerSoftwareInfo ClientAuthentication EncryptionInfo EnhancedMonitoring OpenMonitoring LoggingInfo NumberOfBrokerNodes ZookeeperConnectString ZookeeperConnectStringTls StorageMode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-msk/refs/heads/main/json-structure/msk-api-provisioned-structure.json",
  "name": "Provisioned",
  "type": "object",
  "description": "\n            <p>Provisioned cluster.</p>",
  "properties": {
    "BrokerNodeGroupInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrokerNodeGroupInfo"
        },
        {
          "xml": {
            "name": "brokerNodeGroupInfo"
          },
          "description": "\n            <p>Information about the brokers.</p>"
        }
      ]
    },
    "CurrentBrokerSoftwareInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrokerSoftwareInfo"
        },
        {
          "xml": {
            "name": "currentBrokerSoftwareInfo"
          },
          "description": "\n            <p>Information about the Apache Kafka version deployed on the brokers.</p>"
        }
      ]
    },
    "ClientAuthentication": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientAuthentication"
        },
        {
          "xml": {
            "name": "clientAuthentication"
          },
          "description": "\n            <p>Includes all client authentication information.</p>"
        }
      ]
    },
    "EncryptionInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionInfo"
        },
        {
          "xml": {
            "name": "encryptionInfo"
          },
          "description": "\n            <p>Includes all encryption-related information.</p>"
        }
      ]
    },
    "EnhancedMonitoring": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnhancedMonitoring"
        },
        {
          "xml": {
            "name": "enhancedMonitoring"
          },
          "description": "\n            <p>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</p>"
        }
      ]
    },
    "OpenMonitoring": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OpenMonitoringInfo"
        },
        {
          "xml": {
            "name": "openMonitoring"
          },
          "description": "\n            <p>The settings for open monitoring.</p>"
        }
      ]
    },
    "LoggingInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingInfo"
        },
        {
          "xml": {
            "name": "loggingInfo"
          },
          "description": "\n            <p>Log delivery information for the cluster.</p>"
        }
      ]
    },
    "NumberOfBrokerNodes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max15"
        },
        {
          "xml": {
            "name": "numberOfBrokerNodes"
          },
          "description": "\n            <p>The number of broker nodes in the cluster.</p>"
        }
      ]
    },
    "ZookeeperConnectString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "zookeeperConnectString"
          },
          "description": "\n            <p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>"
        }
      ]
    },
    "ZookeeperConnectStringTls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "zookeeperConnectStringTls"
          },
          "description": "\n            <p>The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.</p>"
        }
      ]
    },
    "StorageMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StorageMode"
        },
        {
          "xml": {
            "name": "storageMode"
          },
          "description": "\n            <p>This controls storage mode for supported storage tiers.</p>"
        }
      ]
    }
  },
  "required": [
    "BrokerNodeGroupInfo",
    "NumberOfBrokerNodes"
  ]
}