Amazon MSK · JSON Structure

Msk Api Create Cluster Request Structure

CreateClusterRequest schema from Amazon MSK API

Type: object Properties: 12 Required: 4
BroadcastingMedia ProcessingMedia

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

Properties

BrokerNodeGroupInfo ClientAuthentication ClusterName ConfigurationInfo EncryptionInfo EnhancedMonitoring OpenMonitoring KafkaVersion LoggingInfo NumberOfBrokerNodes Tags 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-create-cluster-request-structure.json",
  "name": "CreateClusterRequest",
  "type": "object",
  "description": "CreateClusterRequest schema from Amazon MSK API",
  "properties": {
    "BrokerNodeGroupInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrokerNodeGroupInfo"
        },
        {
          "xml": {
            "name": "brokerNodeGroupInfo"
          },
          "description": "\n            <p>Information about the broker nodes in the cluster.</p>"
        }
      ]
    },
    "ClientAuthentication": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientAuthentication"
        },
        {
          "xml": {
            "name": "clientAuthentication"
          },
          "description": "\n            <p>Includes all client authentication related information.</p>"
        }
      ]
    },
    "ClusterName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMin1Max64"
        },
        {
          "xml": {
            "name": "clusterName"
          },
          "description": "\n            <p>The name of the cluster.</p>"
        }
      ]
    },
    "ConfigurationInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationInfo"
        },
        {
          "xml": {
            "name": "configurationInfo"
          },
          "description": "\n            <p>Represents the configuration that you want MSK to use for the brokers in a cluster.</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>"
        }
      ]
    },
    "KafkaVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMin1Max128"
        },
        {
          "xml": {
            "name": "kafkaVersion"
          },
          "description": "\n            <p>The version of Apache Kafka.</p>"
        }
      ]
    },
    "LoggingInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingInfo"
        },
        {
          "xml": {
            "name": "loggingInfo"
          }
        }
      ]
    },
    "NumberOfBrokerNodes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max15"
        },
        {
          "xml": {
            "name": "numberOfBrokerNodes"
          },
          "description": "\n            <p>The number of broker nodes in the cluster.</p>"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__mapOf__string"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "\n            <p>Create tags when creating the cluster.</p>"
        }
      ]
    },
    "StorageMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StorageMode"
        },
        {
          "xml": {
            "name": "storageMode"
          },
          "description": "\n            <p>This controls storage mode for supported storage tiers.</p>"
        }
      ]
    }
  },
  "required": [
    "BrokerNodeGroupInfo",
    "KafkaVersion",
    "NumberOfBrokerNodes",
    "ClusterName"
  ]
}