consumers

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

Overview

Name	consumers
Type	Resource
Id	confluent.kafka.consumers

Fields

The following fields are returned by SELECT queries:

get_kafka_consumer

The consumer.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_group_id	string
consumer_id	string
instance_id	string
assignments	object
kind	string
metadata	object

list_kafka_consumers

The list of consumers.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_group_id	string
consumer_id	string
instance_id	string
assignments	object
kind	string
metadata	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_consumer	select	cluster_id, consumer_group_id, consumer_id, kafka_endpoint_id, region, cloud_provider		Return the consumer specified by the consumer_id.
list_kafka_consumers	select	cluster_id, consumer_group_id, kafka_endpoint_id, region, cloud_provider		Return a list of consumers that belong to the specified consumer group.

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)
consumer_group_id	string	The consumer group ID. (example: consumer-group-1)
consumer_id	string	The consumer ID. (example: consumer-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)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)

SELECT examples

get_kafka_consumer

Return the consumer specified by the consumer_id.

SELECT
client_id,
cluster_id,
consumer_group_id,
consumer_id,
instance_id,
assignments,
kind,
metadata
FROM confluent.kafka.consumers
WHERE cluster_id = '{{ cluster_id }}' -- required
AND consumer_group_id = '{{ consumer_group_id }}' -- required
AND consumer_id = '{{ consumer_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_consumers

Return a list of consumers that belong to the specified consumer
group.

SELECT
client_id,
cluster_id,
consumer_group_id,
consumer_id,
instance_id,
assignments,
kind,
metadata
FROM confluent.kafka.consumers
WHERE cluster_id = '{{ cluster_id }}' -- required
AND consumer_group_id = '{{ consumer_group_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;