Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 ]

update-broker-count

Description

Updates the number of broker nodes in the cluster.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-broker-count
--cluster-arn <value>
--current-version <value>
--target-number-of-broker-nodes <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--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-number-of-broker-nodes (integer)

The number of broker nodes that you want the cluster to have after this operation completes successfully.

--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.

Output

ClusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn -> (string)

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