clusters

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

Overview

Name	clusters
Type	Resource
Id	confluent.ksqldb_clusters.clusters

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
_spec	object
api_version	string	APIVersion defines the schema version of this representation of a resource.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Cluster
status	object	The status of the Cluster

Methods

Name	Accessible by	Required Params	Description
get_ksqldbcm_v2cluster	SELECT	environment, id	Make a request to read a cluster.
list_ksqldbcm_v2clusters	SELECT	environment	Retrieve a sorted, filtered, paginated list of all clusters.
create_ksqldbcm_v2cluster	INSERT		Make a request to create a cluster.
delete_ksqldbcm_v2cluster	DELETE	environment, id	Make a request to delete a cluster.

SELECT examples

Retrieve a sorted, filtered, paginated list of all clusters.

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec,
status
FROM confluent.ksqldb_clusters.clusters
WHERE environment = '{{ environment }}';

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO confluent.ksqldb_clusters.clusters (
data__spec
)
SELECT 
'{{ spec }}'
;

Manifest

- name: clusters
  props:
    - name: spec
      props:
        - name: kafka_cluster
          value: string
        - name: credential_identity
          value: string
        - name: environment
          value: string

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM confluent.ksqldb_clusters.clusters
WHERE environment = '{{ environment }}'
AND id = '{{ id }}';