Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

Broker Count

The number of broker nodes in a cluster.

URI

/v1/clusters/clusterArn/nodes/count

HTTP Methods

PUT

Operation ID: UpdateBrokerCount

Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.

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 UpdateBrokerCountResponse

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.

503 Error

503 response

Schemas

Request Bodies

Example PUT

{ "targetNumberOfBrokerNodes": integer, "currentVersion": "string" }

Response Bodies

Example UpdateBrokerCountResponse

{ "clusterArn": "string", "clusterOperationArn": "string" }

Example Error

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

Properties

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.

UpdateBrokerCountRequest

Request body for UpdateBrokerCount.

Property Type Required Description
targetNumberOfBrokerNodes

integer

True

The number of broker nodes that you want the cluster to have after this operation completes successfully.

currentVersion

string

True

The current version of the cluster.

UpdateBrokerCountResponse

Response body for UpdateBrokerCount.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

clusterOperationArn

string

False

The Amazon Resource Name (ARN) of the cluster operation.

See Also

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

UpdateBrokerCount