kafka_connect_capabilities_connector_configurations

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

Overview

Name	kafka_connect_capabilities_connector_configurations
Type	Resource
Id	ovh.cloud_database.kafka_connect_capabilities_connector_configurations

Fields

The following fields are returned by SELECT queries:

list

KafkaConnect connector config property definition

Name	Datatype	Description
name	string	Name of the property
display_name	string	Pretty name of the property (wire: displayName)
default_value	string	Defines the default value is exists (wire: defaultValue)
description	string	Description of the property
group	string	Group to which belongs the property
importance	string	Importance of the property (high, low, medium)
required	boolean	Defines whether the property is required
type	string	Type of data of the property (boolean, class, double, int16, int32, int64, list, password, string, transform)
values	array	Possible values for the property if string and applicable

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	cluster_id, connector_id, service_name		Get Kafka Connect connector configuration

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
connector_id	string (uuid)	Connector ID (wire: connectorId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

list

Get Kafka Connect connector configuration

SELECT
name,
display_name,
default_value,
description,
group,
importance,
required,
type,
values
FROM ovh.cloud_database.kafka_connect_capabilities_connector_configurations
WHERE cluster_id = '{{ cluster_id }}' -- required
AND connector_id = '{{ connector_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;