update-cluster-configuration¶

Description¶

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

Synopsis¶

  update-cluster-configuration
--cluster-arn <value>
--configuration-info <value>
--current-version <value>
[--cli-input-json | --cli-input-yaml]
[--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.

Arn -> (string)

ARN of the configuration to use.

Revision -> (long)

The revision of the configuration to use.

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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.

Table of Contents

Feedback

User Guide