Kafka Topic

Reads IonosCloud Kafka Cluster objects.

The Kafka topic data source can be used to search for and return an existing Kafka Cluster Topic. You can provide a string for the name parameter which will be compared with provisioned Kafka Cluster Topics. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

data "ionoscloud_kafka_cluster_topic" "example" {
  id = <your_kafka_cluster_topic_id>
  cluster_id = <your_kafka_cluster_id>
  location = <your_kafka_cluster_location>
}

By Name

Needs to have the resource be previously created, or a depends_on clause to ensure that the resource is created before this data source is called.

data "ionoscloud_kafka_cluster_topic" "example" {
  name       = "kafka-cluster-topic"
  cluster_id = <your_kafka_cluster_id>
  location = <location_of_kafka_cluster>
}

Argument Reference

  • id - (Optional) ID of an existing Kafka Cluster Topic that you want to search for.

  • name - (Optional) Name of an existing Kafka Cluster Topic that you want to search for.

  • cluster_id - (Required) ID of the Kafka Cluster that the topic belongs to.

  • location - (Required) The location of the Kafka Cluster Topic. Must be the same as the location of the Kafka Cluster. Possible values: de/fra, de/txl

Attributes Reference

The following attributes are returned by the datasource:

  • id - UUID of the Kafka Cluster Topic.

  • name - The name of the Kafka Cluster Topic.

  • cluster_id - The id of the Kafka Cluster that the topic belongs to.

  • replication_factor - The number of replicas of the topic. The replication factor determines how many copies of the topic are stored on different brokers.

  • number_of_partitions - The number of partitions of the topic. Partitions allow for parallel processing of messages.

  • retention_time - This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

  • segment_bytes - This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention.

Last updated