Amazon MSK · JSON Structure

Msk Api Update Storage Request Structure

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

Type: object Properties: 4 Required: 1
BroadcastingMedia ProcessingMedia

UpdateStorageRequest is a JSON Structure definition published by Amazon MSK, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CurrentVersion ProvisionedThroughput StorageMode VolumeSizeGB

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-msk/refs/heads/main/json-structure/msk-api-update-storage-request-structure.json",
  "name": "UpdateStorageRequest",
  "type": "object",
  "description": "\n            <p>Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.</p>",
  "properties": {
    "CurrentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "currentVersion"
          },
          "description": "\n            <p>The version of cluster to update from. A successful operation will then generate a new version.</p>"
        }
      ]
    },
    "ProvisionedThroughput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProvisionedThroughput"
        },
        {
          "xml": {
            "name": "provisionedThroughput"
          },
          "description": "\n            <p>EBS volume provisioned throughput information.</p>"
        }
      ]
    },
    "StorageMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StorageMode"
        },
        {
          "xml": {
            "name": "storageMode"
          },
          "description": "\n            <p>Controls storage mode for supported storage tiers.</p>"
        }
      ]
    },
    "VolumeSizeGB": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "volumeSizeGB"
          },
          "description": "\n            <p>size of the EBS volume to update.</p>"
        }
      ]
    }
  },
  "required": [
    "CurrentVersion"
  ]
}