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.

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 MSK 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 UpdateBrokerStorageResponse

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

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

Response Bodies

Example UpdateBrokerStorageResponse

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

Example Error

{ "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.

Property Type Required Description
volumeSizeGB

integer

True

Size of the EBS volume to update.

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.

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.

UpdateBrokerStorageRequest

Request object for UpdateBrokerStorage.

Property Type Required Description
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.

currentVersion

string

True

The version of cluster to update from. A successful operation will then generate a new version.

UpdateBrokerStorageResponse

Response body for UpdateBrokerStorage.

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:

UpdateBrokerStorage