connector_config

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

Overview

Name	connector_config
Type	Resource
Id	confluent.connect.connector_config

Fields

The following fields are returned by SELECT queries:

get_connectv1_connector_config

Connector.

Name	Datatype	Description
name	string	Name or alias of the class (plugin) for this connector. For Custom Connector, it must be the same as connector_name.
cloud.environment	string	The cloud environment type.
cloud.provider	string	The cloud service provider, e.g. aws, azure, etc.
connector.class	string	The connector class name. E.g. BigQuerySink, GcsSink, etc.
kafka.api.key	string	The kafka cluster api key.
kafka.api.secret	string	The kafka cluster api secret key.
kafka.endpoint	string	The kafka cluster endpoint.
kafka.region	string	The kafka cluster region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connectv1_connector_config	select	connector_name, environment_id, kafka_cluster_id		Get the configuration for the connector.
create_or_update_connectv1_connector_config	replace	connector_name, environment_id, kafka_cluster_id, connector.class, name, kafka.api.key, kafka.api.secret		Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made.

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
connector_name	string	The unique name of the connector.
environment_id	string	The unique identifier of the environment this resource belongs to.
kafka_cluster_id	string	The unique identifier for the Kafka cluster.

SELECT examples

get_connectv1_connector_config

Get the configuration for the connector.

SELECT
name,
cloud.environment,
cloud.provider,
connector.class,
kafka.api.key,
kafka.api.secret,
kafka.endpoint,
kafka.region
FROM confluent.connect.connector_config
WHERE connector_name = '{{ connector_name }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
;

REPLACE examples

create_or_update_connectv1_connector_config

Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made.

REPLACE confluent.connect.connector_config
SET 
connector.class = '{{ connector.class }}',
name = '{{ name }}',
kafka.api.key = '{{ kafka.api.key }}',
kafka.api.secret = '{{ kafka.api.secret }}',
confluent.connector.type = '{{ confluent.connector.type }}',
confluent.custom.plugin.id = '{{ confluent.custom.plugin.id }}',
confluent.custom.connection.endpoints = '{{ confluent.custom.connection.endpoints }}',
confluent.custom.schema.registry.auto = '{{ confluent.custom.schema.registry.auto }}',
confluent.custom.connect.plugin.runtime = '{{ confluent.custom.connect.plugin.runtime }}',
confluent.custom.connect.java.version = '{{ confluent.custom.connect.java.version }}'
WHERE 
connector_name = '{{ connector_name }}' --required
AND environment_id = '{{ environment_id }}' --required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required
AND connector.class = '{{ connector.class }}' --required
AND name = '{{ name }}' --required
AND kafka.api.key = '{{ kafka.api.key }}' --required
AND kafka.api.secret = '{{ kafka.api.secret }}' --required
RETURNING
name,
config,
tasks,
type;