topic_configs

Creates, updates, deletes, gets or lists a topic_configs resource.

Overview

Name	topic_configs
Type	Resource
Id	confluent.kafka.topic_configs

Fields

The following fields are returned by SELECT queries:

get_kafka_topic_config

The topic configuration parameter.

Name	Datatype	Description
name	string
cluster_id	string
topic_name	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
value	string

list_kafka_topic_configs

The list of cluster configs.

Name	Datatype	Description
name	string
cluster_id	string
topic_name	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
value	string

list_kafka_all_topic_configs

The list of cluster configs.

Name	Datatype	Description
name	string
cluster_id	string
topic_name	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_topic_config	select	cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider		Return the configuration parameter with the given name.
list_kafka_topic_configs	select	cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider		Return the list of configuration parameters that belong to the specified topic.
list_kafka_all_topic_configs	select	cluster_id, kafka_endpoint_id, region, cloud_provider		Return the list of configuration parameters for all topics hosted by the specified cluster.
update_kafka_topic_config	replace	cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider		Update the configuration parameter with given name. To update the number of partitions, see https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic.
update_kafka_topic_config_batch	replace	cluster_id, topic_name, kafka_endpoint_id, region, cloud_provider, data		Update or delete a set of topic configuration parameters. Also supports a dry-run mode that only validates whether the operation would succeed if the validate_only request property is explicitly specified and set to true.
delete_kafka_topic_config	delete	cluster_id, topic_name, name, kafka_endpoint_id, region, cloud_provider		Reset the configuration parameter with given name to its default value.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloud_provider	string	Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
kafka_endpoint_id	string	Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)
name	string	The configuration parameter name. (example: compression.type)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)
topic_name	string	The topic name. (example: topic-1)

SELECT examples

get_kafka_topic_config

Return the configuration parameter with the given name.

SELECT
name,
cluster_id,
topic_name,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND name = '{{ name }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_topic_configs

Return the list of configuration parameters that belong to the specified topic.

SELECT
name,
cluster_id,
topic_name,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_all_topic_configs

Return the list of configuration parameters for all topics hosted by the specified
cluster.

SELECT
name,
cluster_id,
topic_name,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

REPLACE examples

update_kafka_topic_config

Update the configuration parameter with given name. To update the
number of partitions, see
https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic.

REPLACE confluent.kafka.topic_configs
SET 
value = '{{ value }}'
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND topic_name = '{{ topic_name }}' --required
AND name = '{{ name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required;

update_kafka_topic_config_batch

Update or delete a set of topic configuration parameters.
Also supports a dry-run mode that only validates whether the operation would succeed if the
validate_only request property is explicitly specified and set to true.

REPLACE confluent.kafka.topic_configs
SET 
data = '{{ data }}',
validate_only = {{ validate_only }}
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND topic_name = '{{ topic_name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
AND data = '{{ data }}' --required;

DELETE examples

delete_kafka_topic_config

Reset the configuration parameter with given name to its default value.

DELETE FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}' --required
AND topic_name = '{{ topic_name }}' --required
AND name = '{{ name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
;