[ aws . kafka ]

update-cluster-kafka-version

Description

Updates the Apache Kafka version for the cluster.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--cluster-arn (string)

The Amazon Resource Name (ARN) of the cluster to be updated.

--configuration-info (structure)

The custom configuration that should be applied on the new version of 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)

Current cluster version.

--target-kafka-version (string)

Target Kafka version.

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

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.