Apache Kafka ConnectorUpdateConfig

Apache Kafka ConnectorUpdateConfig
Certified
Update a Kafka Connect connector's configuration

Replaces the entire configuration of an existing connector, restarting its tasks with the new config. Connect creates the connector if it doesn't already exist. Fails with the API's error body verbatim if config fails the connector plugin's own validation.

yaml
type: io.kestra.plugin.kafka.ConnectorUpdateConfig

Examples

Bump the task count of an existing connector

yaml
id: kafka_connector_update_config
namespace: company.team

tasks:
  - id: update_connector
    type: io.kestra.plugin.kafka.ConnectorUpdateConfig
    connectUrl: http://connect:8083
    connectorName: orders_jdbc_sink
    config:
      connector.class: io.confluent.connect.jdbc.JdbcSinkConnector
      tasks.max: "3"
      topics: orders
      connection.url: jdbc:postgresql://postgres:5432/orders
      connection.user: "{{ secret('POSTGRES_USER') }}"
      connection.password: "{{ secret('POSTGRES_PASSWORD') }}"
      insert.mode: upsert
      pk.mode: record_key

Properties

config *object

Connector configuration

Replaces the connector's entire configuration; must include connector.class and any property required by that connector plugin.

connectUrl *string

Kafka Connect REST API base URL

For example http://connect: 8083. Kafka Connect has no dedicated Java admin client — every operation goes through this REST API.

connectorName *string

Connector name

headers object

Additional HTTP headers

Sent on every request to the Connect REST API. Useful when the worker sits behind a reverse proxy or expects a bearer token, e.g. Authorization: Bearer ....

password string

Basic auth password

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

username string

Basic auth username

Required together with password when the Connect REST API is protected with HTTP basic auth. Leave both unset to call an unauthenticated worker — no Authorization header is sent in that case.

Outputs

config object

SubTypestring

Effective connector configuration, as accepted by Connect

connectorName string

Connector name

taskIds array

SubTypeinteger

Task ids provisioned by Connect for this connector