Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafka ]



Updates the EBS storage associated with MSK brokers.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--cluster-arn <value>
--current-version <value>
--target-broker-ebs-volume-info <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--cluster-arn (string)

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

--current-version (string)

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

--target-broker-ebs-volume-info (list)

Describes the target volume size and the ID of the broker to apply the update to.


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.

KafkaBrokerNodeId -> (string)

The ID of the broker to update.

ProvisionedThroughput -> (structure)

EBS volume provisioned throughput information.

Enabled -> (boolean)

Provisioned throughput is enabled or not.

VolumeThroughput -> (integer)

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

VolumeSizeGB -> (integer)

Size of the EBS volume to update.

Shorthand Syntax:

KafkaBrokerNodeId=string,ProvisionedThroughput={Enabled=boolean,VolumeThroughput=integer},VolumeSizeGB=integer ...

JSON Syntax:

    "KafkaBrokerNodeId": "string",
    "ProvisionedThroughput": {
      "Enabled": true|false,
      "VolumeThroughput": integer
    "VolumeSizeGB": integer

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To update the EBS storage for brokers

The following update-broker-storage example updates the amount of EBS storage for all the brokers in the cluster. Amazon MSK sets the target storage amount for each broker to the amount specified in the example. You can get the current version of the cluster by describing the cluster or by listing all of the clusters.

aws kafka update-broker-storage \
    --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \
    --current-version "K21V3IB1VIZYYH" \
    --target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100"

The output returns an ARN for this update-broker-storage operation. To determine if this operation is complete, use the describe-cluster-operation command with this ARN as input.

    "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
    "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE"

For more information, see Update the EBS Storage for Brokers in the Amazon Managed Streaming for Apache Kafka Developer Guide.


ClusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn -> (string)

The Amazon Resource Name (ARN) of the cluster operation.