Apache Kafka TopicUpdate
CertifiedUpdate a Kafka topic's configuration
Apache Kafka TopicUpdate
Update a Kafka topic's configuration
Incrementally alters an existing topic's configuration, typically retention.ms or retention.bytes to enforce a per-tenant data retention policy.
Only the provided configs are changed; other configs are left untouched. Fails with UnknownTopicOrPartitionException if the topic does not exist.
type: io.kestra.plugin.kafka.TopicUpdateExamples
Shrink retention for a tenant topic to 3 days
id: kafka_topic_update
namespace: company.team
tasks:
- id: update_topic
type: io.kestra.plugin.kafka.TopicUpdate
properties:
bootstrap.servers: localhost:9092
topic: tenant_acme_orders
retentionMs: 259200000
Properties
properties *Requiredobject
Kafka AdminClient properties
Must include bootstrap.servers; accepts any Kafka AdminClient config. Provide base64-encoded content for ssl.keystore.location and ssl.truststore.location when using SSL.
topic *Requiredstring
Topic name
configs object
{}Additional topic-level configs to set
Any other Kafka topic config, for example cleanup.policy or min.insync.replicas.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
retentionBytes integerstring
Retention size in bytes
Maps to the topic-level retention.bytes config.
retentionMs integerstring
Retention duration in milliseconds
Maps to the topic-level retention.ms config.
timeout string
PT30SAdminClient call timeout
Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds).
Outputs
topic string
Updated topic name
updatedConfigs object
Configs that were set on the topic
