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

Description

Updates the cluster's connectivity configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--cluster-arn (string)

The Amazon Resource Name (ARN) of the configuration.

--connectivity-info (structure)

Information about the broker access configuration.

PublicAccess -> (structure)

Public access control for brokers.

Type -> (string)

The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

Shorthand Syntax:

PublicAccess={Type=string}

JSON Syntax:

{
  "PublicAccess": {
    "Type": "string"
  }
}

--current-version (string)

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

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