cluster_links

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

Overview

Name	cluster_links
Type	Resource
Id	confluent.kafka.cluster_links

Fields

Name	Datatype	Description
cluster_link_id	string
destination_cluster_id	string
kind	string
link_error	string
link_error_message	string
link_id	string
link_name	string
link_state	string
metadata	object
remote_cluster_id	string
source_cluster_id	string
tasks	array
topic_names	array

Methods

Name	Accessible by	Required Params	Description
get_kafka_link	SELECT	cluster_id, link_name	link_id in ListLinksResponseData is deprecated and may be removed in a future release. Use the new cluster_link_id instead.
list_kafka_links	SELECT	cluster_id	link_id in ListLinksResponseData is deprecated and may be removed in a future release. Use the new cluster_link_id instead.
create_kafka_link	INSERT	cluster_id	Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload.
delete_kafka_link	DELETE	cluster_id, link_name

SELECT examples

link_id in ListLinksResponseData is deprecated and may be removed in a future release. Use the new cluster_link_id instead.

SELECT
cluster_link_id,
destination_cluster_id,
kind,
link_error,
link_error_message,
link_id,
link_name,
link_state,
metadata,
remote_cluster_id,
source_cluster_id,
tasks,
topic_names
FROM confluent.kafka.cluster_links
WHERE cluster_id = '{{ cluster_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO confluent.kafka.cluster_links (
data__source_cluster_id,
data__destination_cluster_id,
data__remote_cluster_id,
data__cluster_link_id,
data__configs,
cluster_id
)
SELECT 
'{{ source_cluster_id }}',
'{{ destination_cluster_id }}',
'{{ remote_cluster_id }}',
'{{ cluster_link_id }}',
'{{ configs }}',
'{{ cluster_id }}'
;

All Properties

/*+ create */
INSERT INTO confluent.kafka.cluster_links (
cluster_id
)
SELECT 
'{{ cluster_id }}'
;

Manifest

- name: cluster_links
  props:
    - name: cluster_id
      value: string
    - name: source_cluster_id
      value: string
    - name: destination_cluster_id
      value: string
    - name: remote_cluster_id
      value: string
    - name: cluster_link_id
      value: string
    - name: configs
      value: array

DELETE example

Deletes the specified cluster_links resource.

/*+ delete */
DELETE FROM confluent.kafka.cluster_links
WHERE cluster_id = '{{ cluster_id }}'
AND link_name = '{{ link_name }}';