> ## Documentation Index
> Fetch the complete documentation index at: https://upstash-vector.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# upstash_kafka_cluster

> Create and manage Kafka clusters on Upstash.

<RequestExample>
  ```hcl example.tf
  resource "upstash_kafka_cluster" "exampleCluster" {
    cluster_name = "TerraformCluster"
    region       = "eu-west-1"
    multizone    = false
  }
  ```
</RequestExample>

## Schema

### Required

<ParamField query="cluster_name" type="string" required>
  Name of the cluster
</ParamField>

<ParamField query="region" type="string" required>
  Region of the cluster. Possible values (may change) are: `eu-west-1`,
  `us-east-1`
</ParamField>

### Optional

<ParamField query="multizone" type="bool">
  Whether cluster has multizone attribute
</ParamField>

### Read-Only

<ResponseField name="cluster_id" type="string">
  Unique cluster ID for created cluster
</ResponseField>

<ResponseField name="creation_time" type="number">
  Creation time of the cluster
</ResponseField>

<ResponseField name="id" type="string">
  The ID of this resource.
</ResponseField>

<ResponseField name="max_message_size" type="number">
  Max message size for the cluster
</ResponseField>

<ResponseField name="max_messsages_per_second" type="number">
  Max messages per second for the cluster
</ResponseField>

<ResponseField name="max_partitions" type="number">
  Max partitions for the cluster
</ResponseField>

<ResponseField name="max_retention_size" type="number">
  Max retention size of the cluster
</ResponseField>

<ResponseField name="max_retention_time" type="number">
  Max retention time of the cluster
</ResponseField>

<ResponseField name="password" type="string">
  Password for the cluster
</ResponseField>

<ResponseField name="rest_endpoint" type="string">
  REST endpoint of the cluster
</ResponseField>

<ResponseField name="state" type="string">
  State, where the cluster is originated
</ResponseField>

<ResponseField name="tcp_endpoint" type="string">
  TCP endpoint of the cluster
</ResponseField>

<ResponseField name="type" type="string">
  Type of the cluster
</ResponseField>

<ResponseField name="username" type="string">
  Base64 encoded username for the cluster
</ResponseField>