clusters

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

Overview

Name	clusters
Type	Resource
Id	confluent.managed_kafka_clusters.clusters

Fields

vw_clusters

Name	Datatype	Description
id	text	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").
api_endpoint	text	field from the parent object
api_version	text	APIVersion defines the schema version of this representation of a resource.
availability	text	field from the parent object
cloud	text	field from the parent object
config_kind	text	field from the parent object
created_at	text	field from the parent object
display_name	text	field from the parent object
environment	text	field from the parent object
environment_id	text	field from the parent object
environment_related	text	field from the parent object
environment_resource_name	text	field from the parent object
http_endpoint	text	field from the parent object
kafka_bootstrap_endpoint	text	field from the parent object
kind	text	Kind defines the object this REST resource represents.
region	text	field from the parent object
resource_name	text	field from the parent object
self	text	field from the parent object
status_phase	text	field from the parent object
updated_at	text	field from the parent object

clusters

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_cmk_v2cluster	SELECT	environment, id	Make a request to read a cluster.
list_cmk_v2clusters	SELECT	environment	Retrieve a sorted, filtered, paginated list of all clusters.
create_cmk_v2cluster	INSERT		Make a request to create a cluster.
delete_cmk_v2cluster	DELETE	environment, id	Make a request to delete a cluster.
update_cmk_v2cluster	UPDATE	id	Make a request to update a cluster.

SELECT examples

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

vw_clusters

SELECT
id,
api_endpoint,
api_version,
availability,
cloud,
config_kind,
created_at,
display_name,
environment,
environment_id,
environment_related,
environment_resource_name,
http_endpoint,
kafka_bootstrap_endpoint,
kind,
region,
resource_name,
self,
status_phase,
updated_at
FROM confluent.managed_kafka_clusters.vw_clusters
WHERE environment = '{{ environment }}';

clusters

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec,
status
FROM confluent.managed_kafka_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.managed_kafka_clusters.clusters (
data__spec
)
SELECT 
'{{ spec }}'
;

Manifest

- name: clusters
  props:
    - name: spec
      props:
        - name: display_name
          value: string
        - name: availability
          value: string
        - name: cloud
          value: string
        - name: region
          value: string
        - name: config
          props:
            - name: kind
              value: string
        - name: environment
          props:
            - name: id
              value: string
            - name: environment
              value: string
        - name: network
          props:
            - name: id
              value: string
            - name: environment
              value: string
        - name: byok
          props:
            - name: id
              value: string

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE confluent.managed_kafka_clusters.clusters
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified clusters resource.

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