Skip to content

Create Cluster

kafka_create_cluster R Documentation

Creates a new MSK cluster

Description

Creates a new MSK cluster.

Usage

kafka_create_cluster(BrokerNodeGroupInfo, Rebalancing,
  ClientAuthentication, ClusterName, ConfigurationInfo, EncryptionInfo,
  EnhancedMonitoring, OpenMonitoring, KafkaVersion, LoggingInfo,
  NumberOfBrokerNodes, Tags, StorageMode)

Arguments

BrokerNodeGroupInfo

[required] Information about the broker nodes in the cluster.

Rebalancing

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

ClientAuthentication

Includes all client authentication related information.

ClusterName

[required] The name of the cluster.

ConfigurationInfo

Represents the configuration that you want MSK to use for the brokers in a cluster.

EncryptionInfo

Includes all encryption-related information.

EnhancedMonitoring

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

The settings for open monitoring.

KafkaVersion

[required] The version of Apache Kafka.

NumberOfBrokerNodes

[required] The number of broker nodes in the cluster.

Tags

Create tags when creating the cluster.

StorageMode

This controls storage mode for supported storage tiers.

Value

A list with the following syntax:

list(
  ClusterArn = "string",
  ClusterName = "string",
  State = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"HEALING"|"MAINTENANCE"|"REBOOTING_BROKER"|"UPDATING"
)

Request syntax

svc$create_cluster(
  BrokerNodeGroupInfo = list(
    BrokerAZDistribution = "DEFAULT",
    ClientSubnets = list(
      "string"
    ),
    InstanceType = "string",
    SecurityGroups = list(
      "string"
    ),
    StorageInfo = list(
      EbsStorageInfo = list(
        ProvisionedThroughput = list(
          Enabled = TRUE|FALSE,
          VolumeThroughput = 123
        ),
        VolumeSize = 123
      )
    ),
    ConnectivityInfo = list(
      PublicAccess = list(
        Type = "string"
      ),
      VpcConnectivity = list(
        ClientAuthentication = list(
          Sasl = list(
            Scram = list(
              Enabled = TRUE|FALSE
            ),
            Iam = list(
              Enabled = TRUE|FALSE
            )
          ),
          Tls = list(
            Enabled = TRUE|FALSE
          )
        )
      ),
      NetworkType = "IPV4"|"DUAL"
    ),
    ZoneIds = list(
      "string"
    )
  ),
  Rebalancing = list(
    Status = "PAUSED"|"ACTIVE"
  ),
  ClientAuthentication = list(
    Sasl = list(
      Scram = list(
        Enabled = TRUE|FALSE
      ),
      Iam = list(
        Enabled = TRUE|FALSE
      )
    ),
    Tls = list(
      CertificateAuthorityArnList = list(
        "string"
      ),
      Enabled = TRUE|FALSE
    ),
    Unauthenticated = list(
      Enabled = TRUE|FALSE
    )
  ),
  ClusterName = "string",
  ConfigurationInfo = list(
    Arn = "string",
    Revision = 123
  ),
  EncryptionInfo = list(
    EncryptionAtRest = list(
      DataVolumeKMSKeyId = "string"
    ),
    EncryptionInTransit = list(
      ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
      InCluster = TRUE|FALSE
    )
  ),
  EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
  OpenMonitoring = list(
    Prometheus = list(
      JmxExporter = list(
        EnabledInBroker = TRUE|FALSE
      ),
      NodeExporter = list(
        EnabledInBroker = TRUE|FALSE
      )
    )
  ),
  KafkaVersion = "string",
  LoggingInfo = list(
    BrokerLogs = list(
      CloudWatchLogs = list(
        Enabled = TRUE|FALSE,
        LogGroup = "string"
      ),
      Firehose = list(
        DeliveryStream = "string",
        Enabled = TRUE|FALSE
      ),
      S3 = list(
        Bucket = "string",
        Enabled = TRUE|FALSE,
        Prefix = "string"
      )
    )
  ),
  NumberOfBrokerNodes = 123,
  Tags = list(
    "string"
  ),
  StorageMode = "LOCAL"|"TIERED"
)