Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafka ]



Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--cluster-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--cluster-arn (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To describe a cluster

The following describe-cluster example describes an Amazon MSK cluster.

aws kafka describe-cluster \
    --cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5


    "ClusterInfo": {
        "BrokerNodeGroupInfo": {
            "BrokerAZDistribution": "DEFAULT",
            "ClientSubnets": [
            "InstanceType": "kafka.m5.large",
            "SecurityGroups": [
            "StorageInfo": {
                "EbsStorageInfo": {
                    "VolumeSize": 100
        "ClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5",
        "ClusterName": "demo-cluster-1",
        "CreationTime": "2020-07-09T02:31:36.223000+00:00",
        "CurrentBrokerSoftwareInfo": {
            "KafkaVersion": "2.2.1"
        "CurrentVersion": "K3AEGXETSR30VB",
        "EncryptionInfo": {
            "EncryptionAtRest": {
                "DataVolumeKMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a7ca56d5-0768-4b64-a670-339a9fbef81c"
            "EncryptionInTransit": {
                "ClientBroker": "TLS_PLAINTEXT",
                "InCluster": true
        "EnhancedMonitoring": "DEFAULT",
        "OpenMonitoring": {
            "Prometheus": {
                "JmxExporter": {
                    "EnabledInBroker": false
                "NodeExporter": {
                    "EnabledInBroker": false
        "NumberOfBrokerNodes": 2,
        "State": "ACTIVE",
        "Tags": {},
        "ZookeeperConnectString": ",,"

For more information, see Listing Amazon MSK Clusters in the Amazon Managed Streaming for Apache Kafka Developer Guide.


ClusterInfo -> (structure)

The cluster information.

ActiveOperationArn -> (string)

Arn of active cluster operation.

BrokerNodeGroupInfo -> (structure)

Information about the broker nodes.

BrokerAZDistribution -> (string)

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

ClientSubnets -> (list)

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.


InstanceType -> (string)

The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

SecurityGroups -> (list)

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.


StorageInfo -> (structure)

Contains information about storage volumes attached to MSK broker nodes.

EbsStorageInfo -> (structure)

EBS volume information.

VolumeSize -> (integer)

The size in GiB of the EBS volume for the data drive on each broker node.

ClientAuthentication -> (structure)

Includes all client authentication information.

Tls -> (structure)

Details for ClientAuthentication using TLS.

CertificateAuthorityArnList -> (list)

List of ACM Certificate Authority ARNs.


ClusterArn -> (string)

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

ClusterName -> (string)

The name of the cluster.

CreationTime -> (timestamp)

The time when the cluster was created.

CurrentBrokerSoftwareInfo -> (structure)

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

ConfigurationArn -> (string)

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

ConfigurationRevision -> (long)

The revision of the configuration to use. This field isn't visible in this preview release.

KafkaVersion -> (string)

The version of Apache Kafka.

CurrentVersion -> (string)

The current version of the MSK cluster.

EncryptionInfo -> (structure)

Includes all encryption-related information.

EncryptionAtRest -> (structure)

The data-volume encryption details.

DataVolumeKMSKeyId -> (string)

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

EncryptionInTransit -> (structure)

The details for encryption in transit.

ClientBroker -> (string)

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

TLS means that client-broker communication is enabled with TLS only.

TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

PLAINTEXT means that client-broker communication is enabled in plaintext only.

The default value is TLS_PLAINTEXT.

InCluster -> (boolean)

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

EnhancedMonitoring -> (string)

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring .

OpenMonitoring -> (structure)

Settings for open monitoring using Prometheus.

Prometheus -> (structure)

Prometheus settings.

JmxExporter -> (structure)

Indicates whether you want to enable or disable the JMX Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to enable or disable the JMX Exporter.

NodeExporter -> (structure)

Indicates whether you want to enable or disable the Node Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to enable or disable the Node Exporter.

LoggingInfo -> (structure)

BrokerLogs -> (structure)

CloudWatchLogs -> (structure)

Enabled -> (boolean)

LogGroup -> (string)

Firehose -> (structure)

DeliveryStream -> (string)

Enabled -> (boolean)

S3 -> (structure)

Bucket -> (string)

Enabled -> (boolean)

Prefix -> (string)

NumberOfBrokerNodes -> (integer)

The number of broker nodes in the cluster.

State -> (string)

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

StateInfo -> (structure)

Code -> (string)

Message -> (string)

Tags -> (map)

Tags attached to the cluster.

key -> (string)

value -> (string)

ZookeeperConnectString -> (string)

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