connect_clusters

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

Overview

Name	connect_clusters
Type	Resource
Id	confluent.usm.connect_clusters

Fields

The following fields are returned by SELECT queries:

get_usm_v1_connect_cluster

Connect 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_connect_cluster_id	string	The unique identifier of the Connect cluster within the Confluent Platform environment. (example: connect-group-xyz123)
kafka_cluster_id	string	The unique identifier of the metadata Kafka cluster for the Connect Cluster. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
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 Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: AWS)
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (ConnectCluster)
region	string	The home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: us-east-1)

list_usm_v1_connect_clusters

Connect 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_connect_cluster_id	string	The unique identifier of the Connect cluster within the Confluent Platform environment. (example: connect-group-xyz123)
kafka_cluster_id	string	The unique identifier of the metadata Kafka cluster for the Connect Cluster. (example: 4k0R9d1GTS5tI9f4Y2xZ0Q)
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 Connect Cluster should be stored. This field is optional. If provided, 'region' must also be provided. If neither 'cloud' nor 'region' are provided, the cloud provider of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: AWS)
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (ConnectCluster)
region	string	The home region of the Confluent Platform Connect cluster where the metadata should be stored. This field is optional. If provided, 'cloud' must also be provided. If neither 'cloud' nor 'region' are provided, the home region of the associated metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback. (example: us-east-1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_usm_v1_connect_cluster	select	environment, id		Make a request to read a connect cluster.
list_usm_v1_connect_clusters	select	environment	page_size, page_token	Retrieve a sorted, filtered, paginated list of all connect clusters.
create_usm_v1_connect_cluster	insert	confluent_platform_connect_cluster_id, kafka_cluster_id, environment		Make a request to create a connect cluster.
delete_usm_v1_connect_cluster	delete	environment, id		Make a request to delete a connect 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 connect 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_connect_cluster

Make a request to read a connect cluster.

SELECT
id,
confluent_platform_connect_cluster_id,
kafka_cluster_id,
api_version,
cloud,
environment,
kind,
region
FROM confluent.usm.connect_clusters
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_usm_v1_connect_clusters

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

SELECT
id,
confluent_platform_connect_cluster_id,
kafka_cluster_id,
api_version,
cloud,
environment,
kind,
region
FROM confluent.usm.connect_clusters
WHERE environment = '{{ environment }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_usm_v1_connect_cluster

Make a request to create a connect cluster.

INSERT INTO confluent.usm.connect_clusters (
confluent_platform_connect_cluster_id,
kafka_cluster_id,
cloud,
region,
environment
)
SELECT 
'{{ confluent_platform_connect_cluster_id }}' /* required */,
'{{ kafka_cluster_id }}' /* required */,
'{{ cloud }}',
'{{ region }}',
'{{ environment }}' /* required */
RETURNING
id,
confluent_platform_connect_cluster_id,
kafka_cluster_id,
api_version,
cloud,
environment,
kind,
region
;

Manifest

# Description fields are for documentation purposes
- name: connect_clusters
props:
  - name: confluent_platform_connect_cluster_id
    value: "{{ confluent_platform_connect_cluster_id }}"
    description: |
      The unique identifier of the Connect cluster within the Confluent Platform environment.
  - name: kafka_cluster_id
    value: "{{ kafka_cluster_id }}"
    description: |
      The unique identifier of the metadata Kafka cluster for the Connect Cluster.
  - name: cloud
    value: "{{ cloud }}"
    description: |
      The cloud service provider where the metadata for the Connect Cluster should be stored.
      This field is optional. If provided, 'region' must also be provided.
      If neither 'cloud' nor 'region' are provided, the cloud provider of the associated
      metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.
  - name: region
    value: "{{ region }}"
    description: |
      The home region of the Confluent Platform Connect cluster where the metadata should be stored.
      This field is optional. If provided, 'cloud' must also be provided.
      If neither 'cloud' nor 'region' are provided, the home region of the associated
      metadata Kafka cluster (identified by 'kafka_cluster_id') will be used as a fallback.
  - 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_connect_cluster

Make a request to delete a connect cluster.

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