Apache Kafka ScramCredentialCreate

Apache Kafka ScramCredentialCreate

Certified

Create or update a Kafka SCRAM user credential

Upserts a SASL/SCRAM credential for a user using the Kafka AdminClient, typically to provision a per-tenant service account.

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

Provision a SCRAM credential for a tenant service account

yaml
id: kafka_scram_credential_create
namespace: company.team

tasks:
  - id: create_credential
    type: io.kestra.plugin.kafka.ScramCredentialCreate
    properties:
      bootstrap.servers: localhost:9092
    user: tenant-acme-svc
    password: "{{ secret('TENANT_ACME_KAFKA_PASSWORD') }}"
    mechanism: SCRAM_SHA_512
Properties

Password

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.

Username

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultPT30S

AdminClient 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.

Default4096

Iteration count

Number of SCRAM hashing iterations, between 4096 and 16384. Defaults to 4096.

DefaultSCRAM_SHA_512
Possible Values
SCRAM_SHA_256SCRAM_SHA_512

SCRAM mechanism

Defaults to SCRAM_SHA_512.

Iteration count

Possible Values
SCRAM_SHA_256SCRAM_SHA_512

SCRAM mechanism

Username