members

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

Overview

Name	members
Type	Resource
Id	kafka.streams_group.members

Fields

The following fields are returned by SELECT queries:

get_kafka_streams_group_member

The streams group member.

Name	Datatype	Description
client_id	string	The client identifier of the Streams group member.
cluster_id	string	The unique identifier of the Kafka cluster.
group_id	string	The unique identifier of the Streams group.
instance_id	string	The instance identifier of the Streams group member.
member_id	string	The unique identifier of the Streams group member.
process_id	string	The process identifier of the Streams group member.
assignments	object
is_classic	boolean	The flag indicating if the member is a classic consumer.
kind	string
member_epoch	integer	The epoch of the Streams group member.
metadata	object
target_assignment	object
topology_epoch	integer	The epoch of the Streams topology for the member.

list_kafka_streams_group_members

The list of members of the streams group

Name	Datatype	Description
client_id	string	The client identifier of the Streams group member.
cluster_id	string	The unique identifier of the Kafka cluster.
group_id	string	The unique identifier of the Streams group.
instance_id	string	The instance identifier of the Streams group member.
member_id	string	The unique identifier of the Streams group member.
process_id	string	The process identifier of the Streams group member.
assignments	object
is_classic	boolean	The flag indicating if the member is a classic consumer.
kind	string
member_epoch	integer	The epoch of the Streams group member.
metadata	object
target_assignment	object
topology_epoch	integer	The epoch of the Streams topology for the member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_streams_group_member	select	cluster_id, group_id, member_id, kafka_endpoint_id, region, cloud_provider		Return the members specified by the member_id.
list_kafka_streams_group_members	select	cluster_id, group_id, kafka_endpoint_id, region, cloud_provider		Return a list of members that belong to the specified streams 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)
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)
member_id	string	The streams member ID. (example: member-1)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)

SELECT examples

get_kafka_streams_group_member

Return the members specified by the member_id.

SELECT
client_id,
cluster_id,
group_id,
instance_id,
member_id,
process_id,
assignments,
is_classic,
kind,
member_epoch,
metadata,
target_assignment,
topology_epoch
FROM kafka.streams_group.members
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND member_id = '{{ member_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_streams_group_members

Return a list of members that belong to the specified streams group.

SELECT
client_id,
cluster_id,
group_id,
instance_id,
member_id,
process_id,
assignments,
is_classic,
kind,
member_epoch,
metadata,
target_assignment,
topology_epoch
FROM kafka.streams_group.members
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
;