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 *object
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 *string
Topic name
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150callTimeout string
PT30SAdminClient call timeout
Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds). Distinct from the task-level timeout, which lets the worker kill the task without retrying it.
configs object
{}Additional topic-level configs to set
Any other Kafka topic config, for example cleanup.policy or min.insync.replicas.
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.
Outputs
topic string
Updated topic name
updatedConfigs object
Configs that were set on the topic
