kafka_connect_connectors

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

Overview

Name	kafka_connect_connectors
Type	Resource
Id	ovh.cloud_database.kafka_connect_connectors

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Connector ID
name	string	Name of the connector
connector_id	string (uuid)	Connector capability ID (wire: connectorId)
configuration	object	Configuration of the connector
status	string	Status of the connector (CREATING, FAILED, PAUSED, RUNNING, UNASSIGNED)

list

KafkaConnect connector definition

Name	Datatype	Description
id	string (uuid)	Connector ID
name	string	Name of the connector
connector_id	string (uuid)	Connector capability ID (wire: connectorId)
configuration	object	Configuration of the connector
status	string	Status of the connector (CREATING, FAILED, PAUSED, RUNNING, UNASSIGNED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, connector_id, service_name		Get connector
list	select	cluster_id, service_name	x_pagination_mode	List the connectors
create	insert	cluster_id, service_name, configuration, connector_id, name		Create a new connector
update	update	cluster_id, connector_id, service_name, configuration		Update a connector
delete	delete	cluster_id, connector_id, service_name		Delete a connector
pause	exec	clusterId, connectorId, service_name		Pause the kafka connector execution
restart	exec	clusterId, connectorId, service_name		Restart the kafka connector execution
resume	exec	clusterId, connectorId, service_name		Resume the kafka connector execution

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"}})
clusterId	string (uuid)	Cluster ID
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
connectorId	string (uuid)	Connector ID
connector_id	string (uuid)	Connector ID (wire: connectorId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get connector

SELECT
id,
name,
connector_id,
configuration,
status
FROM ovh.cloud_database.kafka_connect_connectors
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
;

list

List the connectors

SELECT
id,
name,
connector_id,
configuration,
status
FROM ovh.cloud_database.kafka_connect_connectors
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new connector

INSERT INTO ovh.cloud_database.kafka_connect_connectors (
configuration,
connector_id,
name,
cluster_id,
service_name
)
SELECT 
'{{ configuration }}' /* required */,
'{{ connector_id }}' /* required */,
'{{ name }}' /* required */,
'{{ cluster_id }}',
'{{ service_name }}'
RETURNING
id,
name,
connector_id,
configuration,
status
;

Manifest

# Description fields are for documentation purposes
- name: kafka_connect_connectors
props:
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the kafka_connect_connectors resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the kafka_connect_connectors resource.
  - name: configuration
    value: "{{ configuration }}"
    description: |
      Configuration of the connector
  - name: connector_id
    value: "{{ connector_id }}"
    description: |
      Connector capability ID
  - name: name
    value: "{{ name }}"
    description: |
      Name of the connector

UPDATE examples

update

Update a connector

UPDATE ovh.cloud_database.kafka_connect_connectors
SET 
configuration = '{{ configuration }}'
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
AND configuration = '{{ configuration }}' --required
RETURNING
id,
name,
connector_id,
configuration,
status;

DELETE examples

delete

Delete a connector

DELETE FROM ovh.cloud_database.kafka_connect_connectors
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
;

Lifecycle Methods

EXEC variables use wire (API) names.

pause

Pause the kafka connector execution

EXEC ovh.cloud_database.kafka_connect_connectors.pause 
@clusterId='{{ clusterId }}' --required, 
@connectorId='{{ connectorId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

restart

Restart the kafka connector execution

EXEC ovh.cloud_database.kafka_connect_connectors.restart 
@clusterId='{{ clusterId }}' --required, 
@connectorId='{{ connectorId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

resume

Resume the kafka connector execution

EXEC ovh.cloud_database.kafka_connect_connectors.resume 
@clusterId='{{ clusterId }}' --required, 
@connectorId='{{ connectorId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;