Table Of Contents

Feedback

User Guide

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

[ aws . kafka ]

update-cluster-configuration

Description

Updates the cluster with the configuration that is specified in the request body.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-cluster-configuration
--cluster-arn <value>
--configuration-info <value>
--current-version <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--cluster-arn (string)

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

--configuration-info (structure)

Represents the configuration that you want MSK to use for the brokers in a cluster.

Shorthand Syntax:

Arn=string,Revision=long

JSON Syntax:

{
  "Arn": "string",
  "Revision": long
}

--current-version (string)

The version of the cluster that needs to be updated.

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

Examples

To update the configuration of an Amazon MSK cluster

The following update-cluster-configuration example updates the configuration of the specified existing MSK cluster. It uses a custom MSK configuration.

aws kafka update-cluster-configuration \
    --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \
    --configuration-info file://configuration-info.json \
    --current-version "K21V3IB1VIZYYH"

Contents of configuration-info.json:

{
    "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
    "Revision": 1
}

The output returns an ARN for this update-cluster-configuration 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 Configuration of an Amazon MSK Cluster in the Amazon Managed Streaming for Apache Kafka Developer Guide.

Output

ClusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn -> (string)

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