Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Clusters

Use this resource to create an Amazon MSK cluster and to get a list of existing clusters.

URI

/v1/clusters

HTTP Methods

GET

Operation ID: ListClusters

Returns a list of all the MSK clusters in the current Region.

Query Parameters

Name Type Required Description
nextToken String False

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

clusterNameFilter String False

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

maxResults String False

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Responses

Status Code Response Model Description
200 ListClustersResponse

Successful response.

400 Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

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.

500 Error

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

POST

Operation ID: CreateCluster

Creates a new MSK cluster.

Responses

Status Code Response Model Description
200 CreateClusterResponse

Successful response.

400 Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

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.

409 Error

This cluster name already exists. Retry your request using another name.

429 Error

429 response

500 Error

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

503 Error

503 response

Schemas

Request Bodies

Example POST

{ "encryptionInfo": { "encryptionInTransit": { "inCluster": boolean, "clientBroker": enum }, "encryptionAtRest": { "dataVolumeKMSKeyId": "string" } }, "numberOfBrokerNodes": integer, "configurationInfo": { "arn": "string", "revision": integer }, "enhancedMonitoring": enum, "clusterName": "string", "kafkaVersion": "string", "clientAuthentication": { "tls": { "certificateAuthorityArnList": [ "string" ] } }, "brokerNodeGroupInfo": { "clientSubnets": [ "string" ], "instanceType": "string", "securityGroups": [ "string" ], "brokerAZDistribution": enum, "storageInfo": { "ebsStorageInfo": { "volumeSize": integer } } }, "tags": { } }

Response Bodies

Example ListClustersResponse

{ "nextToken": "string", "clusterInfoList": [ { "encryptionInfo": { "encryptionInTransit": { "inCluster": boolean, "clientBroker": enum }, "encryptionAtRest": { "dataVolumeKMSKeyId": "string" } }, "zookeeperConnectString": "string", "creationTime": "string", "currentVersion": "string", "tags": { }, "numberOfBrokerNodes": integer, "clusterArn": "string", "activeOperationArn": "string", "enhancedMonitoring": enum, "clusterName": "string", "clientAuthentication": { "tls": { "certificateAuthorityArnList": [ "string" ] } }, "state": enum, "brokerNodeGroupInfo": { "clientSubnets": [ "string" ], "instanceType": "string", "securityGroups": [ "string" ], "brokerAZDistribution": enum, "storageInfo": { "ebsStorageInfo": { "volumeSize": integer } } }, "currentBrokerSoftwareInfo": { "configurationRevision": integer, "kafkaVersion": "string", "configurationArn": "string" } } ] }

Example CreateClusterResponse

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

Example Error

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

Properties

BrokerAZDistribution

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 that you provide when you create the cluster.

  • DEFAULT

BrokerNodeGroupInfo

Describes the setup to be used for the 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

MinLength: 5

MaxLength: 32

True

The type of Amazon EC2 instances to use for 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

brokerAZDistribution

BrokerAZDistribution

False

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 that you provide when you create the cluster.

storageInfo

StorageInfo

False

Contains information about storage volumes attached to MSK broker nodes.

BrokerSoftwareInfo

Information about the current software installed on the cluster.

Property Type Required Description
configurationRevision

integer

Format: int64

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.

ClientAuthentication

Includes all client authentication information.

Property Type Required Description
tls

Tls

False

Details for ClientAuthentication using TLS.

ClientBroker

Client-broker encryption in transit setting.

  • TLS

  • TLS_PLAINTEXT

  • PLAINTEXT

ClusterInfo

Returns information about a cluster.

Property Type Required Description
encryptionInfo

EncryptionInfo

False

Includes all encryption-related information.

zookeeperConnectString

string

False

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

creationTime

string

Format: date-time

False

The time when the cluster was created.

currentVersion

string

False

The current version of the MSK cluster. Cluster versions aren't simple integers. You can obtain the current version by describing the cluster. An example version is KTVPDKIKX0DER.

tags

object

False

Tags attached to the cluster.

numberOfBrokerNodes

integer

False

The number of broker nodes in the cluster.

clusterArn

string

False

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

activeOperationArn

string

False

Arn of active cluster operation.

enhancedMonitoring

EnhancedMonitoring

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.

clientAuthentication

ClientAuthentication

False

Includes all client authentication information.

state

ClusterState

False

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

brokerNodeGroupInfo

BrokerNodeGroupInfo

False

Information about the broker nodes.

currentBrokerSoftwareInfo

BrokerSoftwareInfo

False

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

ClusterState

The state of the cluster.

  • ACTIVE

  • CREATING

  • UPDATING

  • DELETING

  • FAILED

ConfigurationInfo

Specifies the configuration to use for the brokers.

Property Type Required Description
arn

string

True

ARN of the configuration to use.

revision

integer

Format: int64

Minimum: 1

True

The revision of the configuration to use.

CreateClusterRequest

Creates a cluster.

Property Type Required Description
encryptionInfo

EncryptionInfo

False

Includes all encryption-related information.

numberOfBrokerNodes

integer

True

The number of broker nodes in the cluster.

configurationInfo

ConfigurationInfo

False

Represents the configuration that you want MSK to use for the cluster.

enhancedMonitoring

EnhancedMonitoring

False

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

clusterName

string

MinLength: 1

MaxLength: 64

True

The name of the cluster.

kafkaVersion

string

MinLength: 1

MaxLength: 128

True

The version of Apache Kafka.

clientAuthentication

ClientAuthentication

False

Includes all client authentication related information.

brokerNodeGroupInfo

BrokerNodeGroupInfo

True

Information about the broker nodes in the cluster.

tags

object

False

Create tags when creating the cluster.

CreateClusterResponse

Returns information about the created cluster.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

clusterName

string

False

The name of the MSK cluster.

state

ClusterState

False

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

EBSStorageInfo

Contains information about the EBS storage volumes attached to the 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.

EncryptionAtRest

The data-volume encryption details.

Property Type Required Description
dataVolumeKMSKeyId

string

True

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

The settings for encrypting data in transit.

Property Type Required Description
inCluster

boolean

False

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.

clientBroker

ClientBroker

False

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following 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.

EncryptionInfo

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

Property Type Required Description
encryptionInTransit

EncryptionInTransit

False

The details for encryption in transit.

encryptionAtRest

EncryptionAtRest

False

The data-volume encryption details.

EnhancedMonitoring

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.

ListClustersResponse

The response contains an array containing cluster information and a next token if the response is truncated.

Property Type Required Description
nextToken

string

False

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

clusterInfoList

Array of type ClusterInfo

False

Information on each of the MSK clusters in the response.

StorageInfo

Contains information about storage volumes attached to MSK broker nodes.

Property Type Required Description
ebsStorageInfo

EBSStorageInfo

False

EBS volume information.

Tls

Details for client authentication using TLS.

Property Type Required Description
certificateAuthorityArnList

Array of type string

False

List of ACM Certificate Authority ARNs.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListClusters

CreateCluster