cluster_link_configs

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

Overview

Name	cluster_link_configs
Type	Resource
Id	confluent.kafka.cluster_link_configs

Fields

The following fields are returned by SELECT queries:

get_kafka_link_configs

Config name and value

Name	Datatype	Description
name	string
cluster_id	string
link_name	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
value	string

list_kafka_link_configs

Config name and value

Name	Datatype	Description
name	string
cluster_id	string
link_name	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_link_configs	select	cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider
list_kafka_link_configs	select	cluster_id, link_name, kafka_endpoint_id, region, cloud_provider
update_kafka_link_config	replace	cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider, value
update_kafka_link_config_batch	replace	cluster_id, link_name, kafka_endpoint_id, region, cloud_provider, data	validate_only	Batch Alter Cluster Link Configs
delete_kafka_link_config	delete	cluster_id, link_name, config_name, kafka_endpoint_id, region, cloud_provider

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
cloud_provider	string	Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
config_name	string	The link config name (example: consumer.offset.sync.enable)
kafka_endpoint_id	string	Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)
link_name	string	The link name (example: link-sb1)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)
validate_only	boolean	To validate the action can be performed successfully or not. Default: false (example: false)

SELECT examples

get_kafka_link_configs

SELECT
name,
cluster_id,
link_name,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.cluster_link_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND link_name = '{{ link_name }}' -- required
AND config_name = '{{ config_name }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_link_configs

SELECT
name,
cluster_id,
link_name,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
value
FROM confluent.kafka.cluster_link_configs
WHERE cluster_id = '{{ cluster_id }}' -- required
AND link_name = '{{ link_name }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

REPLACE examples

update_kafka_link_config

REPLACE confluent.kafka.cluster_link_configs
SET 
value = '{{ value }}'
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND link_name = '{{ link_name }}' --required
AND config_name = '{{ config_name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
AND value = '{{ value }}' --required;

update_kafka_link_config_batch

Batch Alter Cluster Link Configs

REPLACE confluent.kafka.cluster_link_configs
SET 
data = '{{ data }}',
validate_only = {{ validate_only }}
WHERE 
cluster_id = '{{ cluster_id }}' --required
AND link_name = '{{ link_name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
AND data = '{{ data }}' --required
AND validate_only = {{ validate_only}};

DELETE examples

delete_kafka_link_config

DELETE FROM confluent.kafka.cluster_link_configs
WHERE cluster_id = '{{ cluster_id }}' --required
AND link_name = '{{ link_name }}' --required
AND config_name = '{{ config_name }}' --required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' --required
AND region = '{{ region }}' --required
AND cloud_provider = '{{ cloud_provider }}' --required
;