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 ]

create-cluster-v2

Description

Creates a new MSK cluster.

See also: AWS API Documentation

Synopsis

  create-cluster-v2
--cluster-name <value>
[--tags <value>]
[--provisioned <value>]
[--serverless <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-name (string)

The name of the cluster.

--tags (map)

A map of tags that you want the cluster to have.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--provisioned (structure)

Information about the provisioned cluster.

BrokerNodeGroupInfo -> (structure)

Information about the brokers.

BrokerAZDistribution -> (string)

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

ClientSubnets -> (list)

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

(string)

InstanceType -> (string)

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

SecurityGroups -> (list)

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

(string)

StorageInfo -> (structure)

Contains information about storage volumes attached to MSK broker nodes.

EbsStorageInfo -> (structure)

EBS volume information.

ProvisionedThroughput -> (structure)

EBS volume provisioned throughput information.

Enabled -> (boolean)

Provisioned throughput is enabled or not.

VolumeThroughput -> (integer)

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

VolumeSize -> (integer)

The size in GiB of the EBS volume for the data drive on each broker node.

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

ClientAuthentication -> (structure)

Includes all client authentication information.

Sasl -> (structure)

Details for ClientAuthentication using SASL.

Scram -> (structure)

Details for SASL/SCRAM client authentication.

Enabled -> (boolean)

SASL/SCRAM authentication is enabled or not.

Iam -> (structure)

Indicates whether IAM access control is enabled.

Enabled -> (boolean)

Indicates whether IAM access control is enabled.

Tls -> (structure)

Details for ClientAuthentication using TLS.

CertificateAuthorityArnList -> (list)

List of ACM Certificate Authority ARNs.

(string)

Enabled -> (boolean)

Specifies whether you want to turn on or turn off TLS authentication.

Unauthenticated -> (structure)

Contains information about unauthenticated traffic to the cluster.

Enabled -> (boolean)

Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

ConfigurationInfo -> (structure)

Represents the configuration that you want Amazon 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.

EncryptionInfo -> (structure)

Includes all encryption-related information.

EncryptionAtRest -> (structure)

The data-volume encryption details.

DataVolumeKMSKeyId -> (string)

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

EncryptionInTransit -> (structure)

The details for encryption in transit.

ClientBroker -> (string)

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

TLS means that client-broker communication is enabled with TLS only.

TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

PLAINTEXT means that client-broker communication is enabled in plaintext only.

The default value is TLS_PLAINTEXT.

InCluster -> (boolean)

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

EnhancedMonitoring -> (string)

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

OpenMonitoring -> (structure)

The settings for open monitoring.

Prometheus -> (structure)

Prometheus settings.

JmxExporter -> (structure)

Indicates whether you want to turn on or turn off the JMX Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to turn on or turn off the JMX Exporter.

NodeExporter -> (structure)

Indicates whether you want to turn on or turn off the Node Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to turn on or turn off the Node Exporter.

KafkaVersion -> (string)

The Apache Kafka version that you want for the cluster.

LoggingInfo -> (structure)

Log delivery information for the cluster.

BrokerLogs -> (structure)

CloudWatchLogs -> (structure)

Enabled -> (boolean)

LogGroup -> (string)

Firehose -> (structure)

DeliveryStream -> (string)

Enabled -> (boolean)

S3 -> (structure)

Bucket -> (string)

Enabled -> (boolean)

Prefix -> (string)

NumberOfBrokerNodes -> (integer)

The number of broker nodes in the cluster.

JSON Syntax:

{
  "BrokerNodeGroupInfo": {
    "BrokerAZDistribution": "DEFAULT",
    "ClientSubnets": ["string", ...],
    "InstanceType": "string",
    "SecurityGroups": ["string", ...],
    "StorageInfo": {
      "EbsStorageInfo": {
        "ProvisionedThroughput": {
          "Enabled": true|false,
          "VolumeThroughput": integer
        },
        "VolumeSize": integer
      }
    },
    "ConnectivityInfo": {
      "PublicAccess": {
        "Type": "string"
      }
    }
  },
  "ClientAuthentication": {
    "Sasl": {
      "Scram": {
        "Enabled": true|false
      },
      "Iam": {
        "Enabled": true|false
      }
    },
    "Tls": {
      "CertificateAuthorityArnList": ["string", ...],
      "Enabled": true|false
    },
    "Unauthenticated": {
      "Enabled": true|false
    }
  },
  "ConfigurationInfo": {
    "Arn": "string",
    "Revision": long
  },
  "EncryptionInfo": {
    "EncryptionAtRest": {
      "DataVolumeKMSKeyId": "string"
    },
    "EncryptionInTransit": {
      "ClientBroker": "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
      "InCluster": true|false
    }
  },
  "EnhancedMonitoring": "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
  "OpenMonitoring": {
    "Prometheus": {
      "JmxExporter": {
        "EnabledInBroker": true|false
      },
      "NodeExporter": {
        "EnabledInBroker": true|false
      }
    }
  },
  "KafkaVersion": "string",
  "LoggingInfo": {
    "BrokerLogs": {
      "CloudWatchLogs": {
        "Enabled": true|false,
        "LogGroup": "string"
      },
      "Firehose": {
        "DeliveryStream": "string",
        "Enabled": true|false
      },
      "S3": {
        "Bucket": "string",
        "Enabled": true|false,
        "Prefix": "string"
      }
    }
  },
  "NumberOfBrokerNodes": integer
}

--serverless (structure)

Information about the serverless cluster.

VpcConfigs -> (list)

The configuration of the Amazon VPCs for the cluster.

(structure)

The configuration of the Amazon VPCs for the cluster.

SubnetIds -> (list)

The IDs of the subnets associated with the cluster.

(string)

SecurityGroupIds -> (list)

The IDs of the security groups associated with the cluster.

(string)

ClientAuthentication -> (structure)

Includes all client authentication information.

Sasl -> (structure)

Details for ClientAuthentication using SASL.

Iam -> (structure)

Indicates whether IAM access control is enabled.

Enabled -> (boolean)

Indicates whether IAM access control is enabled.

JSON Syntax:

{
  "VpcConfigs": [
    {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
    ...
  ],
  "ClientAuthentication": {
    "Sasl": {
      "Iam": {
        "Enabled": true|false
      }
    }
  }
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

ClusterType -> (string)

The type of the cluster. The possible states are PROVISIONED or SERVERLESS.