aiven.getKafkaTopic

func LookupKafkaTopic(ctx *Context, args *LookupKafkaTopicArgs, opts ...InvokeOption) (*LookupKafkaTopicResult, error)
func LookupKafkaTopicOutput(ctx *Context, args *LookupKafkaTopicOutputArgs, opts ...InvokeOption) LookupKafkaTopicResultOutput

> Note: This function is named LookupKafkaTopic in the Go SDK.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ServiceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

TopicName string

The name of the topic. Changing this property forces recreation of the resource.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ServiceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

TopicName string

The name of the topic. Changing this property forces recreation of the resource.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName String

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

topicName String

The name of the topic. Changing this property forces recreation of the resource.

project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

topicName string

The name of the topic. Changing this property forces recreation of the resource.

project str

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

service_name str

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

topic_name str

The name of the topic. Changing this property forces recreation of the resource.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName String

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

topicName String

The name of the topic. Changing this property forces recreation of the resource.

Configs List<GetKafkaTopicConfig>

Advanced parameters to configure topics.

Id string

The provider-assigned unique ID for this managed resource.

OwnerUserGroupId string

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

Partitions int

The number of partitions to create in the topic.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Replication int

The replication factor for the topic.

ServiceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Tags List<GetKafkaTopicTag>

Tags for the topic.

TerminationProtection bool

TopicDescription string

The description of the topic

TopicName string

The name of the topic. Changing this property forces recreation of the resource.

Configs []GetKafkaTopicConfig

Advanced parameters to configure topics.

Id string

The provider-assigned unique ID for this managed resource.

OwnerUserGroupId string

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

Partitions int

The number of partitions to create in the topic.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Replication int

The replication factor for the topic.

ServiceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Tags []GetKafkaTopicTag

Tags for the topic.

TerminationProtection bool

TopicDescription string

The description of the topic

TopicName string

The name of the topic. Changing this property forces recreation of the resource.

configs List<GetKafkaTopicConfig>

Advanced parameters to configure topics.

id String

The provider-assigned unique ID for this managed resource.

ownerUserGroupId String

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

partitions Integer

The number of partitions to create in the topic.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

replication Integer

The replication factor for the topic.

serviceName String

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

tags List<GetKafkaTopicTag>

Tags for the topic.

terminationProtection Boolean

topicDescription String

The description of the topic

topicName String

The name of the topic. Changing this property forces recreation of the resource.

configs GetKafkaTopicConfig[]

Advanced parameters to configure topics.

id string

The provider-assigned unique ID for this managed resource.

ownerUserGroupId string

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

partitions number

The number of partitions to create in the topic.

project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

replication number

The replication factor for the topic.

serviceName string

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

tags GetKafkaTopicTag[]

Tags for the topic.

terminationProtection boolean

topicDescription string

The description of the topic

topicName string

The name of the topic. Changing this property forces recreation of the resource.

configs Sequence[GetKafkaTopicConfig]

Advanced parameters to configure topics.

id str

The provider-assigned unique ID for this managed resource.

owner_user_group_id str

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

partitions int

The number of partitions to create in the topic.

project str

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

replication int

The replication factor for the topic.

service_name str

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

tags Sequence[GetKafkaTopicTag]

Tags for the topic.

termination_protection bool

topic_description str

The description of the topic

topic_name str

The name of the topic. Changing this property forces recreation of the resource.

configs List<Property Map>

Advanced parameters to configure topics.

id String

The provider-assigned unique ID for this managed resource.

ownerUserGroupId String

The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.

partitions Number

The number of partitions to create in the topic.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

replication Number

The replication factor for the topic.

serviceName String

The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

tags List<Property Map>

Tags for the topic.

terminationProtection Boolean

topicDescription String

The description of the topic

topicName String

The name of the topic. Changing this property forces recreation of the resource.

CleanupPolicy string

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

CompressionType string

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

DeleteRetentionMs string

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

DisklessEnable bool

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

FileDeleteDelayMs string

The time to wait before deleting a file from the filesystem.

FlushMessages string

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

FlushMs string

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

IndexIntervalBytes string

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

LocalRetentionBytes string

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

LocalRetentionMs string

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

MaxCompactionLagMs string

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

MaxMessageBytes string

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

MessageDownconversionEnable bool

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

MessageFormatVersion string

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

MessageTimestampDifferenceMaxMs string

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

MessageTimestampType string

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

MinCleanableDirtyRatio double

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

MinCompactionLagMs string

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

MinInsyncReplicas string

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

Preallocate bool

True if we should preallocate the file on disk when creating a new log segment.

RemoteStorageEnable bool

Indicates whether tiered storage should be enabled.

RetentionBytes string

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

RetentionMs string

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

SegmentBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

SegmentIndexBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

SegmentJitterMs string

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

SegmentMs string

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

UncleanLeaderElectionEnable bool

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

CleanupPolicy string

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

CompressionType string

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

DeleteRetentionMs string

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

DisklessEnable bool

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

FileDeleteDelayMs string

The time to wait before deleting a file from the filesystem.

FlushMessages string

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

FlushMs string

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

IndexIntervalBytes string

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

LocalRetentionBytes string

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

LocalRetentionMs string

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

MaxCompactionLagMs string

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

MaxMessageBytes string

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

MessageDownconversionEnable bool

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

MessageFormatVersion string

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

MessageTimestampDifferenceMaxMs string

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

MessageTimestampType string

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

MinCleanableDirtyRatio float64

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

MinCompactionLagMs string

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

MinInsyncReplicas string

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

Preallocate bool

True if we should preallocate the file on disk when creating a new log segment.

RemoteStorageEnable bool

Indicates whether tiered storage should be enabled.

RetentionBytes string

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

RetentionMs string

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

SegmentBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

SegmentIndexBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

SegmentJitterMs string

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

SegmentMs string

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

UncleanLeaderElectionEnable bool

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

cleanupPolicy String

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

compressionType String

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

deleteRetentionMs String

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

disklessEnable Boolean

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

fileDeleteDelayMs String

The time to wait before deleting a file from the filesystem.

flushMessages String

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

flushMs String

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

indexIntervalBytes String

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

localRetentionBytes String

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

localRetentionMs String

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

maxCompactionLagMs String

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

maxMessageBytes String

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

messageDownconversionEnable Boolean

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

messageFormatVersion String

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

messageTimestampDifferenceMaxMs String

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

messageTimestampType String

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

minCleanableDirtyRatio Double

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

minCompactionLagMs String

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

minInsyncReplicas String

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

preallocate Boolean

True if we should preallocate the file on disk when creating a new log segment.

remoteStorageEnable Boolean

Indicates whether tiered storage should be enabled.

retentionBytes String

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

retentionMs String

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

segmentBytes String

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentIndexBytes String

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentJitterMs String

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

segmentMs String

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

uncleanLeaderElectionEnable Boolean

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

cleanupPolicy string

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

compressionType string

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

deleteRetentionMs string

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

disklessEnable boolean

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

fileDeleteDelayMs string

The time to wait before deleting a file from the filesystem.

flushMessages string

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

flushMs string

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

indexIntervalBytes string

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

localRetentionBytes string

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

localRetentionMs string

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

maxCompactionLagMs string

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

maxMessageBytes string

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

messageDownconversionEnable boolean

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

messageFormatVersion string

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

messageTimestampDifferenceMaxMs string

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

messageTimestampType string

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

minCleanableDirtyRatio number

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

minCompactionLagMs string

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

minInsyncReplicas string

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

preallocate boolean

True if we should preallocate the file on disk when creating a new log segment.

remoteStorageEnable boolean

Indicates whether tiered storage should be enabled.

retentionBytes string

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

retentionMs string

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

segmentBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentIndexBytes string

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentJitterMs string

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

segmentMs string

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

uncleanLeaderElectionEnable boolean

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

cleanup_policy str

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

compression_type str

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

delete_retention_ms str

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

diskless_enable bool

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

file_delete_delay_ms str

The time to wait before deleting a file from the filesystem.

flush_messages str

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

flush_ms str

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

index_interval_bytes str

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

local_retention_bytes str

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

local_retention_ms str

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

max_compaction_lag_ms str

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

max_message_bytes str

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

message_downconversion_enable bool

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

message_format_version str

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

message_timestamp_difference_max_ms str

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

message_timestamp_type str

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

min_cleanable_dirty_ratio float

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

min_compaction_lag_ms str

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

min_insync_replicas str

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

preallocate bool

True if we should preallocate the file on disk when creating a new log segment.

remote_storage_enable bool

Indicates whether tiered storage should be enabled.

retention_bytes str

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

retention_ms str

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

segment_bytes str

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segment_index_bytes str

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segment_jitter_ms str

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

segment_ms str

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

unclean_leader_election_enable bool

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

cleanupPolicy String

The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. The possible values are compact, compact,delete and delete.

compressionType String

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. The possible values are gzip, lz4, producer, snappy, uncompressed and zstd.

deleteRetentionMs String

The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

disklessEnable Boolean

Creates a diskless topic. You can only do this when you create the topic and you cannot change it later. Diskless topics are only available for bring your own cloud (BYOC) services that have the feature enabled.

fileDeleteDelayMs String

The time to wait before deleting a file from the filesystem.

flushMessages String

This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

flushMs String

This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient.

indexIntervalBytes String

This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this.

localRetentionBytes String

This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.

localRetentionMs String

This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.

maxCompactionLagMs String

The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.

maxMessageBytes String

The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.

messageDownconversionEnable Boolean

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers.

messageFormatVersion String

Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don't understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be 'None'. The possible values are 0.10.0, 0.10.0-IV0, 0.10.0-IV1, 0.10.1, 0.10.1-IV0, 0.10.1-IV1, 0.10.1-IV2, 0.10.2, 0.10.2-IV0, 0.11.0, 0.11.0-IV0, 0.11.0-IV1, 0.11.0-IV2, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 1.0, 1.0-IV0, 1.1, 1.1-IV0, 2.0, 2.0-IV0, 2.0-IV1, 2.1, 2.1-IV0, 2.1-IV1, 2.1-IV2, 2.2, 2.2-IV0, 2.2-IV1, 2.3, 2.3-IV0, 2.3-IV1, 2.4, 2.4-IV0, 2.4-IV1, 2.5, 2.5-IV0, 2.6, 2.6-IV0, 2.7, 2.7-IV0, 2.7-IV1, 2.7-IV2, 2.8, 2.8-IV0, 2.8-IV1, 3.0, 3.0-IV0, 3.0-IV1, 3.1, 3.1-IV0, 3.2, 3.2-IV0, 3.3, 3.3-IV0, 3.3-IV1, 3.3-IV2, 3.3-IV3, 3.4, 3.4-IV0, 3.5, 3.5-IV0, 3.5-IV1, 3.5-IV2, 3.6, 3.6-IV0, 3.6-IV1, 3.6-IV2, 3.7, 3.7-IV0, 3.7-IV1, 3.7-IV2, 3.7-IV3, 3.7-IV4, 3.8, 3.8-IV0, 3.9, 3.9-IV0, 3.9-IV1, 4.0, 4.0-IV0, 4.1 and 4.1-IV0.

messageTimestampDifferenceMaxMs String

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime.

messageTimestampType String

Define whether the timestamp in the message is message create time or log append time. The possible values are CreateTime and LogAppendTime.

minCleanableDirtyRatio Number

This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.

minCompactionLagMs String

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

minInsyncReplicas String

When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write.

preallocate Boolean

True if we should preallocate the file on disk when creating a new log segment.

remoteStorageEnable Boolean

Indicates whether tiered storage should be enabled.

retentionBytes String

This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.

retentionMs String

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

segmentBytes String

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentIndexBytes String

This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.

segmentJitterMs String

The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling

segmentMs String

This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds.

uncleanLeaderElectionEnable Boolean

Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss.

Key string

Tag key. Maximum length: 64.

Value string

Tag value. Maximum length: 256.

Key string

Tag key. Maximum length: 64.

Value string

Tag value. Maximum length: 256.

key String

Tag key. Maximum length: 64.

value String

Tag value. Maximum length: 256.

key string

Tag key. Maximum length: 64.

value string

Tag value. Maximum length: 256.

key str

Tag key. Maximum length: 64.

value str

Tag value. Maximum length: 256.

key String

Tag key. Maximum length: 64.

value String

Tag value. Maximum length: 256.