connector_config

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

Overview

Name	connector_config
Type	Resource
Id	confluent.connect.connector_config

Fields

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

Name	Accessible by	Required Params	Description
get_connectv1connector_config	SELECT	connector_name, environment_id, kafka_cluster_id	Get the configuration for the connector.
create_or_update_connectv1connector_config	INSERT	connector_name, environment_id, kafka_cluster_id, data__connector.class, data__kafka.api.key, data__kafka.api.secret, data__name	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.

SELECT examples

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 }}'
AND environment_id = '{{ environment_id }}'
AND kafka_cluster_id = '{{ kafka_cluster_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO confluent.connect.connector_config (
data__connector.class,
data__name,
data__kafka.api.key,
data__kafka.api.secret,
data__confluent.connector.type,
data__confluent.custom.plugin.id,
data__confluent.custom.connection.endpoints,
data__confluent.custom.schema.registry.auto,
connector_name,
environment_id,
kafka_cluster_id
)
SELECT 
'{{ connector.class }}',
'{{ name }}',
'{{ kafka.api.key }}',
'{{ kafka.api.secret }}',
'{{ confluent.connector.type }}',
'{{ confluent.custom.plugin.id }}',
'{{ confluent.custom.connection.endpoints }}',
'{{ confluent.custom.schema.registry.auto }}',
'{{ connector_name }}',
'{{ environment_id }}',
'{{ kafka_cluster_id }}'
;

All Properties

/*+ create */
INSERT INTO confluent.connect.connector_config (
data__connector.class,
data__name,
data__kafka.api.key,
data__kafka.api.secret,
connector_name,
environment_id,
kafka_cluster_id
)
SELECT 
'{{ connector.class }}',
'{{ name }}',
'{{ kafka.api.key }}',
'{{ kafka.api.secret }}',
'{{ connector_name }}',
'{{ environment_id }}',
'{{ kafka_cluster_id }}'
;

Manifest

- name: connector_config
  props:
    - name: connector_name
      value: string
    - name: environment_id
      value: string
    - name: kafka_cluster_id
      value: string
    - name: data__connector.class
      value: string
    - name: data__kafka.api.key
      value: string
    - name: data__kafka.api.secret
      value: string
    - name: data__name
      value: string
    - name: connector.class
      value: string
    - name: name
      value: string
    - name: kafka.api.key
      value: string
    - name: kafka.api.secret
      value: string
    - name: confluent.connector.type
      value: string
    - name: confluent.custom.plugin.id
      value: string
    - name: confluent.custom.connection.endpoints
      value: string
    - name: confluent.custom.schema.registry.auto
      value: string