JSON Schema Kafka

Properties

Property	Type	Required	Description
`auto_create_topics_enable`	boolean	no	Enable auto creation of topics
`compression_type`	string	no	Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (‘gzip’, ‘snappy’, ’lz4’, ‘zstd’). It additionally accepts ‘uncompressed’ which is equivalent to no compression; and ‘producer’ which means retain the original compression codec set by the producer. Allowed values: `gzip`, `snappy`, `lz4`, `zstd`, `uncompressed`, `producer`.
`connections_max_idle_ms`	integer	no	Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. Min: `1000`. Max: `3.6e+06`.
`default_replication_factor`	integer	no	Replication factor for autocreated topics Min: `1`. Max: `10`.
`group_initial_rebalance_delay_ms`	integer	no	The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. Min: `0`. Max: `300000`.
`group_max_session_timeout_ms`	integer	no	The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Min: `0`. Max: `1.8e+06`.
`group_min_session_timeout_ms`	integer	no	The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Min: `0`. Max: `60000`.
`log-cleanup-and-compaction`	Log Cleanup And Compaction	no
`log_flush_interval_messages`	integer	no	The number of messages accumulated on a log partition before messages are flushed to disk Min: `1`. Max: `9.223372036854776e+18`.
`log_flush_interval_ms`	integer	no	The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used Min: `0`. Max: `9.223372036854776e+18`.
`log_index_interval_bytes`	integer	no	The interval with which Kafka adds an entry to the offset index Min: `0`. Max: `1.048576e+08`.
`log_index_size_max_bytes`	integer	no	The maximum size in bytes of the offset index Min: `1.048576e+06`. Max: `1.048576e+08`.
`log_local_retention_bytes`	integer	no	The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. Min: `-2`. Max: `9.223372036854776e+18`.
`log_local_retention_ms`	integer	no	The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. Min: `-2`. Max: `9.223372036854776e+18`.
`log_message_downconversion_enable`	boolean	no	This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests.
`log_message_timestamp_difference_max_ms`	integer	no	The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message Min: `0`. Max: `9.223372036854776e+18`.
`log_message_timestamp_type`	string	no	Define whether the timestamp in the message is message create time or log append time. Allowed values: `CreateTime`, `LogAppendTime`.
`log_preallocate`	boolean	no	Should pre allocate file when create new segment?
`log_retention_bytes`	integer	no	The maximum size of the log before deleting messages Min: `-1`. Max: `9.223372036854776e+18`.
`log_retention_hours`	integer	no	The number of hours to keep a log file before deleting it Min: `-1`. Max: `2.147483647e+09`.
`log_retention_ms`	integer	no	The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. Min: `-1`. Max: `9.223372036854776e+18`.
`log_roll_jitter_ms`	integer	no	The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used Min: `0`. Max: `9.223372036854776e+18`.
`log_roll_ms`	integer	no	The maximum time before a new log segment is rolled out (in milliseconds). Min: `1`. Max: `9.223372036854776e+18`.
`log_segment_bytes`	integer	no	The maximum size of a single log file Min: `1.048576e+07`. Max: `1.073741824e+09`.
`log_segment_delete_delay_ms`	integer	no	The amount of time to wait before deleting a file from the filesystem Min: `0`. Max: `3.6e+06`.
`max_connections_per_ip`	integer	no	The maximum number of connections allowed from each ip address (defaults to 2147483647). Min: `256`. Max: `2.147483647e+09`.
`max_incremental_fetch_session_cache_slots`	integer	no	The maximum number of incremental fetch sessions that the broker will maintain. Min: `1000`. Max: `10000`.
`message_max_bytes`	integer	no	The maximum size of message that the server can receive. Min: `0`. Max: `1.000012e+08`.
`min_insync_replicas`	integer	no	When a producer sets acks to ‘all’ (or ‘-1’), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. Min: `1`. Max: `7`.
`num_partitions`	integer	no	Number of partitions for autocreated topics Min: `1`. Max: `1000`.
`offsets_retention_minutes`	integer	no	Log retention window in minutes for offsets topic Min: `1`. Max: `2.147483647e+09`.
`producer_purgatory_purge_interval_requests`	integer	no	The purge interval (in number of requests) of the producer request purgatory(defaults to 1000). Min: `10`. Max: `10000`.
`replica_fetch_max_bytes`	integer	no	The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. Min: `1.048576e+06`. Max: `1.048576e+08`.
`replica_fetch_response_max_bytes`	integer	no	Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. Min: `1.048576e+07`. Max: `1.048576e+09`.
`sasl_oauthbearer_expected_audience`	string	no	The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. Max length: `128`.
`sasl_oauthbearer_expected_issuer`	string	no	Optional setting for the broker to use to verify that the JWT was created by the expected issuer. Max length: `128`.
`sasl_oauthbearer_jwks_endpoint_url`	string	no	OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. Max length: `2048`.
`sasl_oauthbearer_sub_claim_name`	string	no	Name of the scope from which to extract the subject claim from the JWT. Defaults to sub. Max length: `128`.
`socket_request_max_bytes`	integer	no	The maximum number of bytes in a socket request (defaults to 104857600). Min: `1.048576e+07`. Max: `2.097152e+08`.
`transaction_partition_verification_enable`	boolean	no	Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition
`transaction_remove_expired_transaction_cleanup_interval_ms`	integer	no	The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). Min: `600000`. Max: `3.6e+06`.
`transaction_state_log_segment_bytes`	integer	no	The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)). Min: `1.048576e+06`. Max: `2.147483647e+09`.

Log Cleanup And Compaction

Property	Type	Required	Description
`log_cleaner_delete_retention_ms`	integer	no	How long are delete records retained? Min: `0`. Max: `3.1556926e+11`.
`log_cleaner_max_compaction_lag_ms`	integer	no	The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted Min: `30000`. Max: `9.223372036854776e+18`.
`log_cleaner_min_cleanable_ratio`	number	no	Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. Min: `0.2`. Max: `0.9`.
`log_cleaner_min_compaction_lag_ms`	integer	no	The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. Min: `0`. Max: `9.223372036854776e+18`.
`log_cleanup_policy`	string	no	The default cleanup policy for segments beyond the retention window Allowed values: `delete`, `compact`, `compact,delete`.

Last updated on May 29, 2026