Amazon Managed Streaming for Kafka
Amazon Managed Streaming for Kafka API Reference

Cluster

Represents an Amazon MSK cluster.

URI

/v1/clusters/ clusterArn

HTTP Methods

GET

Operation ID: DescribeCluster

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

Path Parameters

Name Type Required Description
clusterArn String True

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

Responses

Status Code Response Model Description
200 DescribeClusterResponse

Successful response.

400 Error

Bad request due to incorrect input. Correct your request and then retry it.

401 Error

The request is not authorized. The provided credentials couldn't be validated.

403 Error

Access forbidden. Check your credentials and then retry your request.

404 Error

The resource could not be found due to incorrect input. Correct your request and then retry it.

500 Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

See Also

DELETE

Operation ID: DeleteCluster

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

Path Parameters

Name Type Required Description
clusterArn String True

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

Query Parameters

Name Type Required Description
currentVersion String False

The current version of the MSK cluster.

Responses

Status Code Response Model Description
200 DeleteClusterResponse

Successful response.

400 Error

Bad request due to incorrect input. Correct your request and then retry it.

403 Error

Access forbidden. Check your credentials and then retry your request.

404 Error

The resource could not be found due to incorrect input. Correct your request and then retry it.

500 Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

See Also

Schemas

Response Bodies

Example DescribeClusterResponse

{ "clusterInfo": { "encryptionInfo": { "encryptionAtRest": { "dataVolumeKMSKeyId": "string" } }, "numberOfBrokerNodes": integer, "zookeeperConnectString": "string", "clusterArn": "string", "creationTime": "string", "enhancedMonitoring": enum, "clusterName": "string", "state": enum, "brokerNodeGroupInfo": { "clientSubnets": [ "string" ], "instanceType": "string", "securityGroups": [ "string" ], "brokerAZDistribution": enum, "storageInfo": { "ebsStorageInfo": { "volumeSize": integer } } }, "currentVersion": "string", "currentBrokerSoftwareInfo": { "configurationRevision": "string", "kafkaVersion": "string", "configurationArn": "string" } } }

Example DeleteClusterResponse

{ "clusterArn": "string", "state": enum }

Example Error

{ "message": "string", "invalidParameter": "string" }

Properties

BrokerAZDistribution (enum)

The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among three Availability Zones. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out.

  • DEFAULT

BrokerNodeGroupInfo

Describes the setup to be used for Kafka broker nodes in the cluster.

Property Type Required Description
clientSubnets

Array of type string

True

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

True

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

Array of type string

False

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.

brokerAZDistribution

string

False

The distribution of broker nodes across Availability Zones.

storageInfo

StorageInfo

False

Contains information about storage volumes attached to MSK broker nodes.

See Also

BrokerSoftwareInfo

Information about the current software installed on the cluster.

Property Type Required Description
configurationRevision

string

False

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

kafkaVersion

string

False

The version of Apache Kafka.

configurationArn

string

False

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

See Also

ClusterInfo

Returns information about a cluster.

Property Type Required Description
encryptionInfo

EncryptionInfo

False

Includes all encryption-related information.

numberOfBrokerNodes

integer

False

The number of Kafka broker nodes in the cluster.

zookeeperConnectString

string

False

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

clusterArn

string

False

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

creationTime

string

Format: date-time

False

The time when the cluster was created.

enhancedMonitoring

string

False

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.

clusterName

string

False

The name of the cluster.

state

string

False

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

brokerNodeGroupInfo

BrokerNodeGroupInfo

False

Information about the broker nodes.

currentVersion

string

False

The current version of the MSK cluster.

currentBrokerSoftwareInfo

BrokerSoftwareInfo

False

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

See Also

ClusterState (enum)

The state of a Kafka cluster.

  • ACTIVE

  • CREATING

  • DELETING

  • FAILED

DeleteClusterResponse

Returns information about the deleted cluster.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

state

string

False

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

See Also

DescribeClusterResponse

Returns information about a cluster.

Property Type Required Description
clusterInfo

ClusterInfo

False

The cluster information.

See Also

EBSStorageInfo

Contains information about the EBS storage volumes attached to Kafka broker nodes.

Property Type Required Description
volumeSize

integer

Minimum: 1

Maximum: 16384

False

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

See Also

EncryptionAtRest

The data volume encryption details.

Property Type Required Description
dataVolumeKMSKeyId

string

True

The AWS KMS key used for data encryption.

See Also

EncryptionInfo

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest.

Property Type Required Description
encryptionAtRest

EncryptionAtRest

False

The data volume encryption details.

See Also

EnhancedMonitoring (enum)

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.

  • DEFAULT

  • PER_BROKER

  • PER_TOPIC_PER_BROKER

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

See Also

StorageInfo

Contains information about storage volumes attached to MSK broker nodes.

Property Type Required Description
ebsStorageInfo

EBSStorageInfo

False

EBS volume information.

See Also