Table Of Contents

Feedback

User Guide

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

[ aws . kafka ]

create-cluster

Description

Creates a new MSK cluster.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-cluster
--broker-node-group-info <value>
[--client-authentication <value>]
--cluster-name <value>
[--configuration-info <value>]
[--encryption-info <value>]
[--enhanced-monitoring <value>]
--kafka-version <value>
--number-of-broker-nodes <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--broker-node-group-info (structure)

Information about the broker nodes in the cluster.

Shorthand Syntax:

BrokerAZDistribution=string,ClientSubnets=string,string,InstanceType=string,SecurityGroups=string,string,StorageInfo={EbsStorageInfo={VolumeSize=integer}}

JSON Syntax:

{
  "BrokerAZDistribution": "DEFAULT",
  "ClientSubnets": ["string", ...],
  "InstanceType": "string",
  "SecurityGroups": ["string", ...],
  "StorageInfo": {
    "EbsStorageInfo": {
      "VolumeSize": integer
    }
  }
}

--client-authentication (structure)

Includes all client authentication related information.

Shorthand Syntax:

Tls={CertificateAuthorityArnList=[string,string]}

JSON Syntax:

{
  "Tls": {
    "CertificateAuthorityArnList": ["string", ...]
  }
}

--cluster-name (string)

The name of 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
}

--encryption-info (structure)

Includes all encryption-related information.

Shorthand Syntax:

EncryptionAtRest={DataVolumeKMSKeyId=string},EncryptionInTransit={ClientBroker=string,InCluster=boolean}

JSON Syntax:

{
  "EncryptionAtRest": {
    "DataVolumeKMSKeyId": "string"
  },
  "EncryptionInTransit": {
    "ClientBroker": "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
    "InCluster": true|false
  }
}

--enhanced-monitoring (string)

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

Possible values:

  • DEFAULT
  • PER_BROKER
  • PER_TOPIC_PER_BROKER

--kafka-version (string)

The version of Apache Kafka.

--number-of-broker-nodes (integer)

The number of broker nodes in the cluster.

--tags (map)

Create tags when creating the cluster.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

ClusterName -> (string)

The name of the MSK cluster.

State -> (string)

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.