Kafka parameters

Parameters for creating a service

These parameters are provided as parameters in the method CreateService.

When creating a new service, the parameters marked as Required should be provided.

If the selected version Kafka supports other parameters, they can be set in the options parameter.

version

Installed version.

Required	Datatype	Valid values
Yes	String	3.6.1 3.7.0

monitoring - The monitoring information for the instance

Connection to a monitoring service.

Required	Editable	Datatype	Valid values	Defaults
For all services, except for Prometheus	Yes	Boolean	true false	false

monitorBy

Monitoring service ID. The specified service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid values
Yes, if the monitoring = true parameter is passed. If monitoring = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

monitoringLabels

Labels to be assigned to the metrics of the monitored service in the monitoring service.

Required	Editable	Datatype	Valid values
No. If monitoring = false, the parameter cannot be passed	Yes	Dict	The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters.

logging

Connection to a logging service.

Required	Editable	Datatype	Valid values	Defaults
For all services, except for ELK and Prometheus	Yes	Boolean	true false	false

logTo

Logging service ID. The logged service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid values	Defaults
Yes, if the logging = true parameter is passed. If logging = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

loggingTags

Tags to be assigned in the logging service to the log records of the current service.

Required	Editable	Datatype	Valid values	Defaults
No. If logging = false, the parameter cannot be passed	Yes	List of strings	String of 256 characters max

options

Container for other parameters Kafka.

Note

If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.

Required	Datatype	Valid values
No	Dict	N/A

Parameters for creating and modifying a Kafka topic

These parameters are specified as parameters in the CreateKafkaTopic and ModifyKafkaTopic methods

When creating a new Kafka topic, make sure to specify all parameters marked as Required. When modifying an existing Kafka topic, make sure to pass all parameters that are editable. If a parameter is not passed, its value will be cleared. Parameters that cannot be edited are not required to be passed, but their values must match the current values if passed.

partitions

Number of partitions in the topic.

Required	Editable	Datatype	Valid values
Yes	Yes	Integer	From 1 to the number of broker nodes When editing the parameter, the number of partitions in the topics cannot be decreased

replicationFactor

Number of the partition replicas.

Required	Editable	Datatype	Valid values
Yes	Yes	Integer	From 1 to the number of broker nodes

cleanupPolicy

Required	Editable	Datatype	Valid values
No	Yes	String	compact delete delete,compact

compressionType

Required	Editable	Datatype	Valid values
No	Yes	String	uncompressed zstd lz4 snappy gzip producer

deleteRetentionMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

fileDeleteDelayMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

flushMessages

Required	Editable	Datatype	Valid values
No	Yes	Integer	1– 9223372036854775807

flushMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

indexIntervalBytes

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 2147483647

maxCompactionLagMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	1– 9223372036854775807

maxMessageBytes

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 2147483647

messageTimestampAfterMaxMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

messageTimestampBeforeMaxMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

messageTimestampType

Required	Editable	Datatype	Valid values
No	Yes	String	CreateTime LogAppendTime

minCleanableDirtyRatio

Required	Editable	Datatype	Valid values
No	Yes	Float	0–1 in increments of 0.1

minCompactionLagMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

minInsyncReplicas

Required	Editable	Datatype	Valid values
No	Yes	Integer	1– 2147483647

preallocate

Required	Editable	Datatype	Valid values
No	Yes	Boolean	true false

retentionBytes

Required	Editable	Datatype	Valid values
No	Yes	Integer	-1– 2147483647

retentionMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	-1– 9223372036854775807

segmentBytes

Required	Editable	Datatype	Valid values
No	Yes	Integer	14– 2147483647

segmentIndexBytes

Required	Editable	Datatype	Valid values
No	Yes	Integer	4– 2147483647

segmentJitterMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	0– 9223372036854775807

segmentMs

Required	Editable	Datatype	Valid values
No	Yes	Integer	1– 9223372036854775807