Kafka / Client / update_broker_count

update_broker_count#

Kafka.Client.update_broker_count(**kwargs)#

Updates the number of broker nodes in the cluster.

See also: AWS API Documentation

Request Syntax

response = client.update_broker_count(
    ClusterArn='string',
    CurrentVersion='string',
    TargetNumberOfBrokerNodes=123
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

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

  • CurrentVersion (string) –

    [REQUIRED]

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

  • TargetNumberOfBrokerNodes (integer) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

  • (dict) –

    Successful response.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • ClusterOperationArn (string) –

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

Exceptions