{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-msk/refs/heads/main/json-schema/msk-api-cluster-info-schema.json", "title": "ClusterInfo", "description": "\n

Returns information about a cluster.

", "type": "object", "properties": { "ActiveOperationArn": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "activeOperationArn" }, "description": "\n

Arn of active cluster operation.

" } ] }, "BrokerNodeGroupInfo": { "allOf": [ { "$ref": "#/components/schemas/BrokerNodeGroupInfo" }, { "xml": { "name": "brokerNodeGroupInfo" }, "description": "\n

Information about the broker nodes.

" } ] }, "ClientAuthentication": { "allOf": [ { "$ref": "#/components/schemas/ClientAuthentication" }, { "xml": { "name": "clientAuthentication" }, "description": "\n

Includes all client authentication information.

" } ] }, "ClusterArn": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "clusterArn" }, "description": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

" } ] }, "ClusterName": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "clusterName" }, "description": "\n

The name of the cluster.

" } ] }, "CreationTime": { "allOf": [ { "$ref": "#/components/schemas/__timestampIso8601" }, { "xml": { "name": "creationTime" }, "description": "\n

The time when the cluster was created.

" } ] }, "CurrentBrokerSoftwareInfo": { "allOf": [ { "$ref": "#/components/schemas/BrokerSoftwareInfo" }, { "xml": { "name": "currentBrokerSoftwareInfo" }, "description": "\n

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

" } ] }, "CurrentVersion": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "currentVersion" }, "description": "\n

The current version of the MSK cluster.

" } ] }, "EncryptionInfo": { "allOf": [ { "$ref": "#/components/schemas/EncryptionInfo" }, { "xml": { "name": "encryptionInfo" }, "description": "\n

Includes all encryption-related information.

" } ] }, "EnhancedMonitoring": { "allOf": [ { "$ref": "#/components/schemas/EnhancedMonitoring" }, { "xml": { "name": "enhancedMonitoring" }, "description": "\n

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 Monitoring.

" } ] }, "OpenMonitoring": { "allOf": [ { "$ref": "#/components/schemas/OpenMonitoring" }, { "xml": { "name": "openMonitoring" }, "description": "\n

Settings for open monitoring using Prometheus.

" } ] }, "LoggingInfo": { "allOf": [ { "$ref": "#/components/schemas/LoggingInfo" }, { "xml": { "name": "loggingInfo" } } ] }, "NumberOfBrokerNodes": { "allOf": [ { "$ref": "#/components/schemas/__integer" }, { "xml": { "name": "numberOfBrokerNodes" }, "description": "\n

The number of broker nodes in the cluster.

" } ] }, "State": { "allOf": [ { "$ref": "#/components/schemas/ClusterState" }, { "xml": { "name": "state" }, "description": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" } ] }, "StateInfo": { "allOf": [ { "$ref": "#/components/schemas/StateInfo" }, { "xml": { "name": "stateInfo" } } ] }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/__mapOf__string" }, { "xml": { "name": "tags" }, "description": "\n

Tags attached to the cluster.

" } ] }, "ZookeeperConnectString": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "zookeeperConnectString" }, "description": "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

" } ] }, "ZookeeperConnectStringTls": { "allOf": [ { "$ref": "#/components/schemas/__string" }, { "xml": { "name": "zookeeperConnectStringTls" }, "description": "\n

The connection string to use to connect to zookeeper cluster on Tls port.

" } ] }, "StorageMode": { "allOf": [ { "$ref": "#/components/schemas/StorageMode" }, { "xml": { "name": "storageMode" }, "description": "\n

This controls storage mode for supported storage tiers.

" } ] } } }