Broker Storage - Amazon Managed Streaming for Apache Kafka
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Broker Storage

Represents the EBS storage associated with the brokers.

URI

/v1/clusters/clusterArn/nodes/storage

HTTP methods

PUT

Operation ID: UpdateBrokerStorage

Updates the EBS storage associated with Amazon MSK brokers. You can increase the amount of EBS storage per broker. You can't decrease the storage. To increase storage, wait for the cluster to be in the ACTIVE state. Storage volumes remain available during this scaling-up operation.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200 UpdateBrokerStorageResponse

Successful response.

400Error

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

401Error

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

403Error

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

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

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

503Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Request bodies

{ "targetBrokerEBSVolumeInfo": [ { "volumeSizeGB": integer, "kafkaBrokerNodeId": "string" } ], "currentVersion": "string" }

Response bodies

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

Properties

BrokerEBSVolumeInfo

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

PropertyTypeRequiredDescription
kafkaBrokerNodeId

string

True

The ID of the broker to update. The only allowed value is ALL. This means that Amazon MSK applies the same storage update to all broker nodes.

volumeSizeGB

integer

True

Size of the EBS volume to update.

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

UpdateBrokerStorageRequest

Request object for UpdateBrokerStorage.

PropertyTypeRequiredDescription
currentVersion

string

True

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

targetBrokerEBSVolumeInfo

Array of type BrokerEBSVolumeInfo

True

Describes the target volume size and the ID of the broker to apply the update to.

The value you specify for Target-Volume-in-GiB must be a whole number that is greater than 100 GiB.

The storage per broker after the update operation can't exceed 16384 GiB.

UpdateBrokerStorageResponse

Response body for UpdateBrokerStorage.

PropertyTypeRequiredDescription
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

clusterOperationArn

string

False

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