Amazon MSK · JSON Structure
Msk Api Cluster Info Structure
Returns information about a cluster.
Type: object
Properties: 19
BroadcastingMedia ProcessingMedia
ClusterInfo is a JSON Structure definition published by Amazon MSK, describing 19 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
ActiveOperationArn
BrokerNodeGroupInfo
ClientAuthentication
ClusterArn
ClusterName
CreationTime
CurrentBrokerSoftwareInfo
CurrentVersion
EncryptionInfo
EnhancedMonitoring
OpenMonitoring
LoggingInfo
NumberOfBrokerNodes
State
StateInfo
Tags
ZookeeperConnectString
ZookeeperConnectStringTls
StorageMode
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-msk/refs/heads/main/json-structure/msk-api-cluster-info-structure.json",
"name": "ClusterInfo",
"type": "object",
"description": "\n <p>Returns information about a cluster.</p>",
"properties": {
"ActiveOperationArn": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "activeOperationArn"
},
"description": "\n <p>Arn of active cluster operation.</p>"
}
]
},
"BrokerNodeGroupInfo": {
"allOf": [
{
"$ref": "#/components/schemas/BrokerNodeGroupInfo"
},
{
"xml": {
"name": "brokerNodeGroupInfo"
},
"description": "\n <p>Information about the broker nodes.</p>"
}
]
},
"ClientAuthentication": {
"allOf": [
{
"$ref": "#/components/schemas/ClientAuthentication"
},
{
"xml": {
"name": "clientAuthentication"
},
"description": "\n <p>Includes all client authentication information.</p>"
}
]
},
"ClusterArn": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "clusterArn"
},
"description": "\n <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>"
}
]
},
"ClusterName": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "clusterName"
},
"description": "\n <p>The name of the cluster.</p>"
}
]
},
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/__timestampIso8601"
},
{
"xml": {
"name": "creationTime"
},
"description": "\n <p>The time when the cluster was created.</p>"
}
]
},
"CurrentBrokerSoftwareInfo": {
"allOf": [
{
"$ref": "#/components/schemas/BrokerSoftwareInfo"
},
{
"xml": {
"name": "currentBrokerSoftwareInfo"
},
"description": "\n <p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>"
}
]
},
"CurrentVersion": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "currentVersion"
},
"description": "\n <p>The current version of the MSK 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 which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href=\"https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html\">Monitoring</a>.</p>"
}
]
},
"OpenMonitoring": {
"allOf": [
{
"$ref": "#/components/schemas/OpenMonitoring"
},
{
"xml": {
"name": "openMonitoring"
},
"description": "\n <p>Settings for open monitoring using Prometheus.</p>"
}
]
},
"LoggingInfo": {
"allOf": [
{
"$ref": "#/components/schemas/LoggingInfo"
},
{
"xml": {
"name": "loggingInfo"
}
}
]
},
"NumberOfBrokerNodes": {
"allOf": [
{
"$ref": "#/components/schemas/__integer"
},
{
"xml": {
"name": "numberOfBrokerNodes"
},
"description": "\n <p>The number of broker nodes in the cluster.</p>"
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/ClusterState"
},
{
"xml": {
"name": "state"
},
"description": "\n <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>"
}
]
},
"StateInfo": {
"allOf": [
{
"$ref": "#/components/schemas/StateInfo"
},
{
"xml": {
"name": "stateInfo"
}
}
]
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/__mapOf__string"
},
{
"xml": {
"name": "tags"
},
"description": "\n <p>Tags attached to 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 zookeeper cluster on Tls port.</p>"
}
]
},
"StorageMode": {
"allOf": [
{
"$ref": "#/components/schemas/StorageMode"
},
{
"xml": {
"name": "storageMode"
},
"description": "\n <p>This controls storage mode for supported storage tiers.</p>"
}
]
}
}
}