Apache Kafka ConnectorPause

Apache Kafka ConnectorPause
Certified
Pause a Kafka Connect connector

Stops the connector and its tasks from processing records; the connector's configuration and offsets are preserved. Asynchronous — poll ConnectorGetStatus to confirm the PAUSED state has taken effect.

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

Examples

yaml
id: kafka_connector_pause
namespace: company.team

tasks:
  - id: pause_connector
    type: io.kestra.plugin.kafka.ConnectorPause
    connectUrl: http://connect:8083
    connectorName: orders_jdbc_sink

Properties

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

connectorName string

Connector name