cluster_configs

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

Overview

Name	cluster_configs
Type	Resource
Id	confluent.kafka.cluster_configs

Fields

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

Methods

Name	Accessible by	Required Params	Description
get_kafka_cluster_config	SELECT	cluster_id, name	Return the dynamic cluster-wide broker configuration parameter specified by name.
list_kafka_cluster_configs	SELECT	cluster_id	Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.
delete_kafka_cluster_config	DELETE	cluster_id, name	Reset the configuration parameter specified by name to its default value by deleting a dynamic cluster-wide configuration.
update_kafka_cluster_configs	UPDATE	cluster_id, data__data	Update or delete a set of dynamic cluster-wide broker configuration parameters.
update_kafka_cluster_config	EXEC	cluster_id, name	Update the dynamic cluster-wide broker configuration parameter specified by name.

SELECT examples

Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.

SELECT
name,
cluster_id,
config_type,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.cluster_configs
WHERE cluster_id = '{{ cluster_id }}';

UPDATE example

Updates a cluster_configs resource.

/*+ update */
UPDATE confluent.kafka.cluster_configs
SET 
data = '{{ data }}',
validate_only = true|false
WHERE 
cluster_id = '{{ cluster_id }}'
AND data__data = '{{ data__data }}';

DELETE example

Deletes the specified cluster_configs resource.

/*+ delete */
DELETE FROM confluent.kafka.cluster_configs
WHERE cluster_id = '{{ cluster_id }}'
AND name = '{{ name }}';