group_configs

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

Overview

Name	group_configs
Type	Resource
Id	confluent.kafka.group_configs

Fields

The following fields are returned by SELECT queries:

get_kafka_group_config

Config name and value for group configuration.

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

list_kafka_group_configs

Config name and value for group configurations.

Name	Datatype	Description
name	string
cluster_id	string
group_id	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_group_config	select	cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider		Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
list_kafka_group_configs	select	cluster_id, group_id, kafka_endpoint_id, region, cloud_provider		List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
update_kafka_group_config	replace	cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider, value		Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
delete_kafka_group_config	delete	cluster_id, group_id, name, kafka_endpoint_id, region, cloud_provider		Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups.
update_kafka_group_config_batch	exec	cluster_id, group_id, kafka_endpoint_id, region, cloud_provider, data	validate_only	Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups.

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)
group_id	string	The group ID. (example: group-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)
validate_only	boolean	To validate the action can be performed successfully or not. Default: false (example: false)

SELECT examples

get_kafka_group_config

Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.

SELECT
name,
cluster_id,
group_id,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.group_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- 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_group_configs

List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups.

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

REPLACE examples

update_kafka_group_config

Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.

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

DELETE examples

delete_kafka_group_config

Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups.

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

Lifecycle Methods

update_kafka_group_config_batch

Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups.

EXEC confluent.kafka.group_configs.update_kafka_group_config_batch 
@cluster_id='{{ cluster_id }}' --required, 
@group_id='{{ group_id }}' --required, 
@kafka_endpoint_id='{{ kafka_endpoint_id }}' --required, 
@region='{{ region }}' --required, 
@cloud_provider='{{ cloud_provider }}' --required, 
@validate_only={{ validate_only }} 
@@json=
'{
"data": "{{ data }}", 
"validate_only": {{ validate_only }}
}'
;