create-connector
Deploy Kafka connectors by specifying configuration details such as environment, cluster, and connector class. Simplifies integration with Confluent Kafka and Confluent Cloud REST APIs.
Instructions
Create a new connector. Returns the new connector information if successful.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| baseUrl | No | The base URL of the Kafka Connect REST API. | |
| clusterId | No | The unique identifier for the Kafka cluster. | |
| connectorConfig | Yes | ||
| connectorName | Yes | The name of the connector to create. | |
| environmentId | No | The unique identifier for the environment this resource belongs to. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"baseUrl": {
"default": "",
"description": "The base URL of the Kafka Connect REST API.",
"format": "uri",
"type": "string"
},
"clusterId": {
"description": "The unique identifier for the Kafka cluster.",
"type": "string"
},
"connectorConfig": {
"additionalProperties": {
"type": "string"
},
"properties": {
"confluent.connector.type": {
"default": "MANAGED",
"description": "Required for Custom Connector. The connector type",
"type": "string"
},
"confluent.custom.connection.endpoints": {
"description": "Optional for Custom Connector. Egress endpoint(s) for the connector",
"type": "string"
},
"confluent.custom.plugin.id": {
"description": "Required for Custom Connector. The custom plugin id of custom connector",
"type": "string"
},
"confluent.custom.schema.registry.auto": {
"default": "FALSE",
"description": "Optional for Custom Connector. Automatically add required schema registry properties",
"type": "string"
},
"connector.class": {
"description": "Required for Managed Connector, Ignored for Custom Connector. The connector class name, e.g., BigQuerySink, GcsSink, etc.",
"type": "string"
}
},
"required": [
"connector.class"
],
"type": "object"
},
"connectorName": {
"description": "The name of the connector to create.",
"minLength": 1,
"type": "string"
},
"environmentId": {
"description": "The unique identifier for the environment this resource belongs to.",
"type": "string"
}
},
"required": [
"connectorName",
"connectorConfig"
],
"type": "object"
}