URI HTTP methods Schemas Properties See also

UpdateStorage

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

URI

/v1/clusters/clusterArn/storage

HTTP methods

PUT

Operation ID: UpdateStorage

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

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`	`UpdateStorageResponse`	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

OPTIONS

Enable CORS by returning the correct headers.

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`	None	Default response for CORS method

Schemas

Request bodies


{
  "volumeSizeGB": integer,
  "storageMode": enum,
  "provisionedThroughput": {
    "volumeThroughput": integer,
    "enabled": boolean
  },
  "currentVersion": "string"
}

Response bodies


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


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

Properties

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.

StorageMode

Controls storage mode for various supported storage tiers.

LOCAL
TIERED

UpdateStorageRequest

Request object for UpdateStorageApi.

Property	Type	Required	Description
`currentVersion`	string	True	The version of cluster to update from. A successful operation will then generate a new version.
`provisionedThroughput`	ProvisionedThroughput	False	EBS volume provisioned throughput information.
`storageMode`	StorageMode	False	Controls storage mode for supported storage tiers.
`volumeSizeGB`	integer	False	size of the EBS volume to update.

UpdateStorageResponse

Response body for UpdateStorageResponse Api.

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.