URI HTTP methods Schemas Properties See also

Cluster

Represents an Amazon MSK cluster.

URI

/api/v2/clusters/clusterArn

HTTP methods

GET

Operation ID: DescribeClusterV2

Returns information about a cluster.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	ARN of the cluster to be described.

Responses
Status code	Response model	Description
`200`	`DescribeClusterV2Response`	HTTP Status Code 200: OK.
`400`	None	HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
`401`	None	HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
`403`	None	HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
`404`	None	HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
`429`	None	HTTP Status Code 429: Limit exceeded. Resource limit reached.
`500`	None	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
`503`	None	HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

OPTIONS

Enable CORS by returning correct headers

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	ARN of the cluster to be described.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Response bodies


{
  "clusterInfo": {
    "clusterType": enum,
    "clusterArn": "string",
    "activeOperationArn": "string",
    "provisioned": {
      "encryptionInfo": {
        "encryptionInTransit": {
          "inCluster": boolean,
          "clientBroker": enum
        },
        "encryptionAtRest": {
          "dataVolumeKMSKeyId": "string"
        }
      },
      "numberOfBrokerNodes": integer,
      "zookeeperConnectString": "string",
      "customerActionStatus": enum,
      "enhancedMonitoring": enum,
      "zookeeperConnectStringTls": "string",
      "storageMode": enum,
      "clientAuthentication": {
        "sasl": {
          "iam": {
            "enabled": boolean
          },
          "scram": {
            "enabled": boolean
          }
        },
        "unauthenticated": {
          "enabled": boolean
        },
        "tls": {
          "certificateAuthorityArnList": [
            "string"
          ],
          "enabled": boolean
        }
      },
      "loggingInfo": {
        "brokerLogs": {
          "s3": {
            "bucket": "string",
            "prefix": "string",
            "enabled": boolean
          },
          "firehose": {
            "deliveryStream": "string",
            "enabled": boolean
          },
          "cloudWatchLogs": {
            "logGroup": "string",
            "enabled": boolean
          }
        }
      },
      "brokerNodeGroupInfo": {
        "clientSubnets": [
          "string"
        ],
        "zoneIds": [
          "string"
        ],
        "instanceType": "string",
        "connectivityInfo": {
          "vpcConnectivity": {
            "clientAuthentication": {
              "sasl": {
                "iam": {
                  "enabled": boolean
                },
                "scram": {
                  "enabled": boolean
                }
              },
              "tls": {
                "enabled": boolean
              }
            }
          },
          "publicAccess": {
            "type": "string"
          }
        },
        "securityGroups": [
          "string"
        ],
        "brokerAZDistribution": enum,
        "storageInfo": {
          "ebsStorageInfo": {
            "provisionedThroughput": {
              "volumeThroughput": integer,
              "enabled": boolean
            },
            "volumeSize": integer
          }
        }
      },
      "openMonitoring": {
        "prometheus": {
          "nodeExporter": {
            "enabledInBroker": boolean
          },
          "jmxExporter": {
            "enabledInBroker": boolean
          }
        }
      },
      "currentBrokerSoftwareInfo": {
        "configurationRevision": integer,
        "kafkaVersion": "string",
        "configurationArn": "string"
      }
    },
    "creationTime": "string",
    "clusterName": "string",
    "serverless": {
      "vpcConfigs": [
        {
          "securityGroupIds": [
            "string"
          ],
          "subnetIds": [
            "string"
          ]
        }
      ],
      "kafkaVersion": "string",
      "clientAuthentication": {
        "sasl": {
          "iam": {
            "enabled": boolean
          }
        }
      }
    },
    "stateInfo": {
      "code": "string",
      "message": "string"
    },
    "state": enum,
    "currentVersion": "string",
    "tags": {
    }
  }
}

Properties

BrokerAZDistribution

The distribution of broker nodes across Availability Zones.

DEFAULT

BrokerLogs

Broker Logs details for cluster.

Property	Type	Required	Description
`cloudWatchLogs`	CloudWatchLogs	False	CloudWatch Log destination details.
`firehose`	Firehose	False
`s3`	S3	False	S3 Log destination details.

BrokerNodeGroupInfo

Describes the setup to be used for the brokers.

Property	Type	Required	Description
`brokerAZDistribution`	BrokerAZDistribution	False	The distribution of broker nodes across Availability Zones.
`clientSubnets`	Array of type string	True	The list of subnets in the client VPC to connect to.
`connectivityInfo`	ConnectivityInfo	False	Information about the cluster access configuration.
`instanceType`	string MinLength: 5 MaxLength: 32	True	The type of broker used for the cluster.
`securityGroups`	Array of type string	False	The security groups to attach to the ENIs for the broker nodes.
`storageInfo`	StorageInfo	False	Data volume information.
`zoneIds`	Array of type string	False	The zoneIds for brokers in customer account.

BrokerSoftwareInfo

Information about current software installed in the cluster.

Property Type Required Description

Property	Type	Required	Description
`configurationArn`	string	False	ARN of the configuration used on the cluster.
`configurationRevision`	integer Format: int64	False	Revision of the configuration to use.
`kafkaVersion`	string	False	The version of Apache Kafka to install and run on the cluster.

configurationArn

string

False

ARN of the configuration used on the cluster.

configurationRevision

integer

Format: int64

False

Revision of the configuration to use.

kafkaVersion

string

False

The version of Apache Kafka to install and run on the cluster.

ClientAuthentication

Includes all client authentication information.

Property	Type	Required	Description
`sasl`	Sasl	False	Details for ClientAuthentication using SASL.
`tls`	Tls	False	Details for ClientAuthentication using TLS.
`unauthenticated`	Unauthenticated	False	Details for ClientAuthentication using no authentication.

ClientBroker

Client-broker encryption in transit setting.

TLS
TLS_PLAINTEXT
PLAINTEXT

CloudWatchLogs

CloudWatchLogs details for BrokerLogs.

Property	Type	Required	Description
`enabled`	boolean	True	Broker logs for destination CW enabled or not.
`logGroup`	string	False	CloudWatch LogGroup where the logs will be delivered.

Cluster

Returns information about a cluster.

Property	Type	Required	Description
`activeOperationArn`	string	False	Arn of active cluster operation.
`clusterArn`	string	False	The Amazon Resource Name (ARN) of the cluster.
`clusterName`	string	False	The name of the cluster.
`clusterType`	ClusterType	False	Type of the backend cluster.
`creationTime`	string	False	The time when the cluster was created.
`currentVersion`	string	False	Current version of cluster.
`provisioned`	Provisioned	False	Properties of a provisioned cluster.
`serverless`	Serverless	False	Properties of a serverless cluster.
`state`	ClusterState	False	State of the cluster.
`stateInfo`	StateInfo	False	Includes information of the cluster state.
`tags`	object	False	Tags attached to the cluster.

ClusterState

The sate of an MSK cluster.

ACTIVE
CREATING
UPDATING
DELETING
FAILED
MAINTENANCE
REBOOTING_BROKER
HEALING

ClusterType

The type of backend cluster.

PROVISIONED
SERVERLESS

ConnectivityInfo

Broker access controls

Property	Type	Required	Description
`publicAccess`	PublicAccess	False	Access control settings for brokers
`vpcConnectivity`	VpcConnectivity	False	VPC connection control settings for brokers

CustomerActionStatus

A type of an action required from the customer.

CRITICAL_ACTION_REQUIRED
ACTION_REQUIRED
NONE

DescribeClusterV2Response

Returns information about a cluster.

Property	Type	Required	Description
`clusterInfo`	Cluster	False	Cluster information

EBSStorageInfo

Contains information about the EBS storage volumes that are attached to the brokers.

Property Type Required Description

Property	Type	Required	Description
`provisionedThroughput`	ProvisionedThroughput	False	EBS volume provisioned throughput information.
`volumeSize`	integer Minimum: 1 Maximum: 16384	False	The size of the EBS volumes for the data drive on each of the brokers in GiB.

provisionedThroughput

ProvisionedThroughput

False

EBS volume provisioned throughput information.

volumeSize

integer

Minimum: 1

Maximum: 16384

False

The size of the EBS volumes for the data drive on each of the brokers in GiB.

EncryptionAtRest

Details for encryption at rest.

Property	Type	Required	Description
`dataVolumeKMSKeyId`	string	True	KMS key used for data volume encryption.

EncryptionInTransit

Details for encryption in transit.

Property	Type	Required	Description
`clientBroker`	ClientBroker	False	Client-broker encryption in transit setting.
`inCluster`	boolean	False	In-cluster encryption in transit setting.

EncryptionInfo

Includes all encryption related information.

Property	Type	Required	Description
`encryptionAtRest`	EncryptionAtRest	False	Details for encryption at rest.
`encryptionInTransit`	EncryptionInTransit	False	Details for encryption in transit.

EnhancedMonitoring

Controls level of cluster metrics Amazon pushes to customer's cloudwatch account.

DEFAULT
PER_BROKER
PER_TOPIC_PER_BROKER
PER_TOPIC_PER_PARTITION

Firehose

Firehose details for BrokerLogs.

Property	Type	Required	Description
`deliveryStream`	string	False	Firehose delivery stream where the logs will be delivered.
`enabled`	boolean	True	Broker logs for destination firehose enabled or not.

IAM

Details for SASL/IAM client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/IAM authentication is enabled or not.

JmxExporter

JMX Exporter details.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	JMX Exporter being enabled in broker.

LoggingInfo

Logging info details for the cluster.

Property	Type	Required	Description
`brokerLogs`	BrokerLogs	True	Broker Logs details.

NodeExporter

Node Exporter details.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	Node Exporter being enabled in broker.

OpenMonitoring

JMX and Node monitoring for cluster.

Property	Type	Required	Description
`prometheus`	Prometheus	True	Prometheus details.

Prometheus

Prometheus details.

Property	Type	Required	Description
`jmxExporter`	JmxExporter	False	JMX Exporter details.
`nodeExporter`	NodeExporter	False	Node Exporter details.

Provisioned

Properties of a provisioned cluster.

Property	Type	Required	Description
`brokerNodeGroupInfo`	BrokerNodeGroupInfo	False	Information about the brokers of the cluster.
`clientAuthentication`	ClientAuthentication	False	Includes all client authentication information.
`currentBrokerSoftwareInfo`	BrokerSoftwareInfo	False	Information about the version of the software that is deployed on the brokers of the cluster.
`customerActionStatus`	CustomerActionStatus	False	Determines if there is an action required from the customer.
`encryptionInfo`	EncryptionInfo	False	Includes all encryption related information.
`enhancedMonitoring`	EnhancedMonitoring	False	This knob controls level of metrics pushed customer's cloudwatch account.
`loggingInfo`	LoggingInfo	False	Logging Info details.
`numberOfBrokerNodes`	integer	False	The number of brokers to create in the cluster.
`openMonitoring`	OpenMonitoring	False	Open monitoring details.
`storageMode`	StorageMode	False	This controls storage mode for supported storage tiers.
`zookeeperConnectString`	string	False	The connection string to use to connect to zookeeper cluster on plaintext port.
`zookeeperConnectStringTls`	string	False	The connection string to use to connect to zookeeper cluster on Tls port.

ProvisionedThroughput

Contains information about provisioned throughput for the EBS storage volumes that are attached to the brokers.

Property	Type	Required	Description
`enabled`	boolean	False	Whether provisioned throughput is turned on.
`volumeThroughput`	integer	False	Throughput value of the EBS volumes for the data drive on each broker in MiB per second.

PublicAccess

Broker access controls

Property	Type	Required	Description
`type`	string	False	If public access is disabled, or if enabled the EIP provider

S3

S3 details for BrokerLogs.

Property	Type	Required	Description
`bucket`	string	False	Name of the bucket where the logs will be delivered.
`enabled`	boolean	True	Broker logs for destination S3 enabled or not.
`prefix`	string	False	prefix to the S3 bucket where the logs will be delivered.

Sasl

Details for client authentication using SASL.

Property	Type	Required	Description
`iam`	IAM	False	Details for ClientAuthentication using IAM.
`scram`	Scram	False	Details for SASL/SCRAM client authentication.

Scram

Details for SASL/SCRAM client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/SCRAM authentication is enabled or not.

Serverless

Properties to create a serverless cluster

Property	Type	Required	Description
`clientAuthentication`	ServerlessClientAuthentication	True	Includes all client authentication related information.
`kafkaVersion`	string	False	The version of Apache Kafka for the serverless cluster.
`vpcConfigs`	Array of type VpcConfig	True	VPC configuration information

ServerlessClientAuthentication

Details for client authentication using SASL.

Property	Type	Required	Description
`sasl`	ServerlessSasl	False	Details for ClientAuthentication using IAM.

ServerlessSasl

Details for client authentication using SASL for Serverless Cluster.

Property	Type	Required	Description
`iam`	IAM	False	Details for ClientAuthentication using IAM for Serverless Cluster.

StateInfo

Includes information about the cluster state.

Property	Type	Required	Description
`code`	string	False	Code for cluster state.
`message`	string	False	Message for cluster state.

StorageInfo

Contains information about the storage volumes that are attached to the brokers.

Property	Type	Required	Description
`ebsStorageInfo`	EBSStorageInfo	False	EBS volume information.

StorageMode

Controls storage mode for various supported storage tiers.

LOCAL
TIERED

Tls

The details of client authentication using TLS.

Property	Type	Required	Description
`certificateAuthorityArnList`	Array of type string	False	List of ACM CertificateAuthority ARNs.
`enabled`	boolean	False	Whether TLS authentication is turned on.

Unauthenticated

Details for allowing no client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	Unauthenticated is enabled or not.

VpcConfig

Includes information about subnets and security groups for a VPC.

Property	Type	Required	Description
`securityGroupIds`	Array of type string	False	The security groups to attach to the ENIs for the broker nodes.
`subnetIds`	Array of type string	True	The list of subnets in the client VPC to connect to. Client subnets can't occupy the Availability Zone with ID use1-az3.

VpcConnectivity

VPC connection control settings for brokers

Property	Type	Required	Description
`clientAuthentication`	VpcConnectivityClientAuthentication	False	VPC connection control settings for brokers

VpcConnectivityClientAuthentication

Includes all client authentication information for VpcConnectivity.

Property	Type	Required	Description
`sasl`	VpcConnectivitySasl	False	Details for VpcConnectivity ClientAuthentication using SASL.
`tls`	VpcConnectivityTls	False	Details for VpcConnectivity ClientAuthentication using TLS.

VpcConnectivityIAM

Details for SASL/IAM client authentication for VpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/IAM authentication is enabled or not.

VpcConnectivitySasl

Details for client authentication using SASL for VpcConnectivity.

Property	Type	Required	Description
`iam`	VpcConnectivityIAM	False	Details for ClientAuthentication using IAM for VpcConnectivity.
`scram`	VpcConnectivityScram	False	Details for SASL/SCRAM client authentication for VpcConnectivity.

VpcConnectivityScram

Details for SASL/SCRAM client authentication for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/SCRAM authentication is enabled or not.

VpcConnectivityTls

Details for client authentication using TLS for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	TLS authentication is enabled or not.