Skip to main content

cluster_configs

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

Overview

Namecluster_configs
TypeResource
Idconfluent.kafka.cluster_configs

Fields

NameDatatypeDescription
namestring
cluster_idstring
config_typestring
is_defaultboolean
is_read_onlyboolean
is_sensitiveboolean
kindstring
metadataobject
sourcestring
synonymsarray
valuestring

Methods

NameAccessible byRequired ParamsDescription
get_kafka_cluster_configSELECTcluster_id, nameGenerally Available Return the dynamic cluster-wide broker configuration parameter specified by name.
list_kafka_cluster_configsSELECTcluster_idGenerally Available 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_configDELETEcluster_id, nameGenerally Available Reset the configuration parameter specified by name to its default value by deleting a dynamic cluster-wide configuration.
update_kafka_cluster_configsUPDATEcluster_id, data__dataGenerally Available Update or delete a set of dynamic cluster-wide broker configuration parameters.
update_kafka_cluster_configEXECcluster_id, nameGenerally Available Update the dynamic cluster-wide broker configuration parameter specified by name.

SELECT examples

Generally Available 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 }}';