Broker Storage
Represents the EBS storage associated with the brokers.
URI
/v1/clusters/
clusterArn
/nodes/storage
HTTP methods
OPTIONS
Enable CORS by returning the correct headers.
Name | Type | Required | Description |
---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
Status code | Response model | Description |
---|---|---|
200 | None | Default response for CORS method |
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.
Name | Type | Required | Description |
---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
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. |
404 | Error | The resource could not be found due to incorrect input. Correct the input, then retry the request. |
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
{ "currentVersion": "string", "targetBrokerEBSVolumeInfo": [ { "kafkaBrokerNodeId": "string", "provisionedThroughput": { "enabled": boolean, "volumeThroughput": integer }, "volumeSizeGB": integer } ] }
Response bodies
{ "clusterArn": "string", "clusterOperationArn": "string" }
{ "invalidParameter": "string", "message": "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 |
---|---|---|---|
kafkaBrokerNodeId | string | True | The ID of the broker to update. The only allowed value is |
provisionedThroughput | False | EBS volume provisioned throughput information. | |
volumeSizeGB | integer | False | Size of the EBS volume to update. |
Error
Returns information about an error.
Property | Type | Required | Description |
---|---|---|---|
invalidParameter | string | False | The parameter that caused the error. |
message | string | False | The description of the error. |
ProvisionedThroughput
Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
Property | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | Provisioned throughput is enabled or not. |
volumeThroughput | integer | False | Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. |
UpdateBrokerStorageRequest
Request object for UpdateBrokerStorage.
Property | Type | Required | Description |
---|---|---|---|
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.
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: