Amazon MSK · JSON Structure

Msk Api Broker Ebs Volume Info Structure

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.

Type: object Properties: 3 Required: 1
BroadcastingMedia ProcessingMedia

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

Properties

KafkaBrokerNodeId ProvisionedThroughput 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-broker-ebs-volume-info-structure.json",
  "name": "BrokerEBSVolumeInfo",
  "type": "object",
  "description": "\n            <p>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.</p>",
  "properties": {
    "KafkaBrokerNodeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "kafkaBrokerNodeId"
          },
          "description": "\n            <p>The ID of the broker to update.</p>"
        }
      ]
    },
    "ProvisionedThroughput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProvisionedThroughput"
        },
        {
          "xml": {
            "name": "provisionedThroughput"
          },
          "description": "\n            <p>EBS volume provisioned throughput information.</p>"
        }
      ]
    },
    "VolumeSizeGB": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "volumeSizeGB"
          },
          "description": "\n            <p>Size of the EBS volume to update.</p>"
        }
      ]
    }
  },
  "required": [
    "KafkaBrokerNodeId"
  ]
}