clusters

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

Overview

Name	clusters
Type	Resource
Id	confluent.kafka.clusters

Fields

The following fields are returned by SELECT queries:

get_kafka_cluster

The Kafka cluster.

Name	Datatype	Description
cluster_id	string
acls	object
broker_configs	object
brokers	object
consumer_groups	object
controller	object
kind	string
metadata	object
partition_reassignments	object
topics	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_cluster	select	cluster_id, kafka_endpoint_id, region, cloud_provider		Return the Kafka cluster with the specified cluster_id.

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)
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_cluster

Return the Kafka cluster with the specified cluster_id.

SELECT
cluster_id,
acls,
broker_configs,
brokers,
consumer_groups,
controller,
kind,
metadata,
partition_reassignments,
topics
FROM confluent.kafka.clusters
WHERE cluster_id = '{{ cluster_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;