kafka_clusters

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

Overview

Name	kafka_clusters
Type	Resource
Id	confluent.usm.kafka_clusters

Fields

The following fields are returned by SELECT queries:

get_usm_v1_kafka_cluster

Kafka Cluster.

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"). (example: dlz-f3a90de)
confluent_platform_kafka_cluster_id	string	The unique identifier of the Kafka cluster within the Confluent Platform environment. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
display_name	string	A human-readable name for the Confluent Platform Kafka cluster. (example: My-Prod-CP-Cluster)
api_version	string	APIVersion defines the schema version of this representation of a resource. (usm/v1)
cloud	string	The cloud service provider where the metadata for the Kafka Cluster should be stored. (example: AWS)
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (KafkaCluster)
region	string	The home region of the Confluent Platform Kafka cluster where the metadata should be stored. (example: us-east-1)

list_usm_v1_kafka_clusters

Kafka Cluster.

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"). (example: dlz-f3a90de)
confluent_platform_kafka_cluster_id	string	The unique identifier of the Kafka cluster within the Confluent Platform environment. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
display_name	string	A human-readable name for the Confluent Platform Kafka cluster. (example: My-Prod-CP-Cluster)
api_version	string	APIVersion defines the schema version of this representation of a resource. (usm/v1)
cloud	string	The cloud service provider where the metadata for the Kafka Cluster should be stored. (example: AWS)
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (KafkaCluster)
region	string	The home region of the Confluent Platform Kafka cluster where the metadata should be stored. (example: us-east-1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_usm_v1_kafka_cluster	select	environment, id		Make a request to read a kafka cluster.
list_usm_v1_kafka_clusters	select	environment	page_size, page_token	Retrieve a sorted, filtered, paginated list of all kafka clusters.
create_usm_v1_kafka_cluster	insert	display_name, confluent_platform_kafka_cluster_id, cloud, region, environment		Make a request to create a kafka cluster.
delete_usm_v1_kafka_cluster	delete	environment, id		Make a request to delete a kafka cluster.

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
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the kafka cluster.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_usm_v1_kafka_cluster

Make a request to read a kafka cluster.

SELECT
id,
confluent_platform_kafka_cluster_id,
display_name,
api_version,
cloud,
environment,
kind,
region
FROM confluent.usm.kafka_clusters
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_usm_v1_kafka_clusters

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

SELECT
id,
confluent_platform_kafka_cluster_id,
display_name,
api_version,
cloud,
environment,
kind,
region
FROM confluent.usm.kafka_clusters
WHERE environment = '{{ environment }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_usm_v1_kafka_cluster

Make a request to create a kafka cluster.

INSERT INTO confluent.usm.kafka_clusters (
display_name,
confluent_platform_kafka_cluster_id,
cloud,
region,
environment
)
SELECT 
'{{ display_name }}' /* required */,
'{{ confluent_platform_kafka_cluster_id }}' /* required */,
'{{ cloud }}' /* required */,
'{{ region }}' /* required */,
'{{ environment }}' /* required */
RETURNING
id,
confluent_platform_kafka_cluster_id,
display_name,
api_version,
cloud,
environment,
kind,
region
;

Manifest

# Description fields are for documentation purposes
- name: kafka_clusters
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      A human-readable name for the Confluent Platform Kafka cluster.
  - name: confluent_platform_kafka_cluster_id
    value: "{{ confluent_platform_kafka_cluster_id }}"
    description: |
      The unique identifier of the Kafka cluster within the Confluent Platform environment.
  - name: cloud
    value: "{{ cloud }}"
    description: |
      The cloud service provider where the metadata for the Kafka Cluster should be stored.
  - name: region
    value: "{{ region }}"
    description: |
      The home region of the Confluent Platform Kafka cluster where the metadata should be stored.
  - name: environment
    description: |
      The environment to which this belongs.
    value:
      id: "{{ id }}"
      environment: "{{ environment }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"

DELETE examples

delete_usm_v1_kafka_cluster

Make a request to delete a kafka cluster.

DELETE FROM confluent.usm.kafka_clusters
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;