getKafkaTopic

Aiven v6.58.0, Jul 3 26

Viewing docs for Aiven v6.58.0
published on Friday, Jul 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v6.58.0
published on Friday, Jul 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const example = aiven.getKafkaTopic({
    project: "my-project",
    serviceName: "my-kafka",
    topicName: "mytopic",
});

import pulumi
import pulumi_aiven as aiven

example = aiven.get_kafka_topic(project="my-project",
    service_name="my-kafka",
    topic_name="mytopic")

package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.GetKafkaTopic(ctx, &aiven.LookupKafkaTopicArgs{
			Project:     "my-project",
			ServiceName: "my-kafka",
			TopicName:   "mytopic",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var example = Aiven.GetKafkaTopic.Invoke(new()
    {
        Project = "my-project",
        ServiceName = "my-kafka",
        TopicName = "mytopic",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetKafkaTopicArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AivenFunctions.getKafkaTopic(GetKafkaTopicArgs.builder()
            .project("my-project")
            .serviceName("my-kafka")
            .topicName("mytopic")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aiven:getKafkaTopic
      arguments:
        project: my-project
        serviceName: my-kafka
        topicName: mytopic

pulumi {
  required_providers {
    aiven = {
      source = "pulumi/aiven"
    }
  }
}

data "aiven_getkafkatopic" "example" {
  project      = "my-project"
  service_name = "my-kafka"
  topic_name   = "mytopic"
}

Using getKafkaTopic

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKafkaTopic(args: GetKafkaTopicArgs, opts?: InvokeOptions): Promise<GetKafkaTopicResult>
function getKafkaTopicOutput(args: GetKafkaTopicOutputArgs, opts?: InvokeOptions): Output<GetKafkaTopicResult>

def get_kafka_topic(configs: Optional[Sequence[GetKafkaTopicConfig]] = None,
                    project: Optional[str] = None,
                    service_name: Optional[str] = None,
                    tags: Optional[Sequence[GetKafkaTopicTag]] = None,
                    timeouts: Optional[GetKafkaTopicTimeouts] = None,
                    topic_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetKafkaTopicResult
def get_kafka_topic_output(configs: pulumi.Input[Optional[Sequence[pulumi.Input[GetKafkaTopicConfigArgs]]]] = None,
                    project: pulumi.Input[Optional[str]] = None,
                    service_name: pulumi.Input[Optional[str]] = None,
                    tags: pulumi.Input[Optional[Sequence[pulumi.Input[GetKafkaTopicTagArgs]]]] = None,
                    timeouts: pulumi.Input[Optional[GetKafkaTopicTimeoutsArgs]] = None,
                    topic_name: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetKafkaTopicResult]

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.

public static class GetKafkaTopic 
{
    public static Task<GetKafkaTopicResult> InvokeAsync(GetKafkaTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaTopicResult> Invoke(GetKafkaTopicInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKafkaTopicResult> getKafkaTopic(GetKafkaTopicArgs args, InvokeOptions options)
public static Output<GetKafkaTopicResult> getKafkaTopic(GetKafkaTopicArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getKafkaTopic:getKafkaTopic
  arguments:
    # arguments dictionary

data "aiven_getkafkatopic" "name" {
    # arguments
}

The following arguments are supported:

Project string: Project name.
ServiceName string: Service name.
TopicName string: Kafka topic name.
Configs List<GetKafkaTopicConfig>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
Tags List<GetKafkaTopicTag>: Topic tags.
Timeouts GetKafkaTopicTimeouts

Project string: Project name.
ServiceName string: Service name.
TopicName string: Kafka topic name.
Configs []GetKafkaTopicConfig: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
Tags []GetKafkaTopicTag: Topic tags.
Timeouts GetKafkaTopicTimeouts

project string: Project name.
service_name string: Service name.
topic_name string: Kafka topic name.
configs list(object): Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags list(object): Topic tags.
timeouts object

project String: Project name.
serviceName String: Service name.
topicName String: Kafka topic name.
configs List<GetKafkaTopicConfig>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags List<GetKafkaTopicTag>: Topic tags.
timeouts GetKafkaTopicTimeouts

project string: Project name.
serviceName string: Service name.
topicName string: Kafka topic name.
configs GetKafkaTopicConfig[]: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags GetKafkaTopicTag[]: Topic tags.
timeouts GetKafkaTopicTimeouts

project str: Project name.
service_name str: Service name.
topic_name str: Kafka topic name.
configs Sequence[GetKafkaTopicConfig]: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags Sequence[GetKafkaTopicTag]: Topic tags.
timeouts GetKafkaTopicTimeouts

project String: Project name.
serviceName String: Service name.
topicName String: Kafka topic name.
configs List<Property Map>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags List<Property Map>: Topic tags.
timeouts Property Map

getKafkaTopic Result

The following output properties are available:

Id string: Resource ID composed as: project/service_name/topic_name.
OwnerUserGroupId string: The user group that owns this topic.
Partitions int: Number of partitions.
Project string: Project name.
Replication int: Number of replicas.
ServiceName string: Service name.
TerminationProtection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
TopicDescription string: Topic description.
TopicName string: Kafka topic name.
Configs List<GetKafkaTopicConfig>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
Tags List<GetKafkaTopicTag>: Topic tags.
Timeouts GetKafkaTopicTimeouts

Id string: Resource ID composed as: project/service_name/topic_name.
OwnerUserGroupId string: The user group that owns this topic.
Partitions int: Number of partitions.
Project string: Project name.
Replication int: Number of replicas.
ServiceName string: Service name.
TerminationProtection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
TopicDescription string: Topic description.
TopicName string: Kafka topic name.
Configs []GetKafkaTopicConfig: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
Tags []GetKafkaTopicTag: Topic tags.
Timeouts GetKafkaTopicTimeouts

id string: Resource ID composed as: project/service_name/topic_name.
owner_user_group_id string: The user group that owns this topic.
partitions number: Number of partitions.
project string: Project name.
replication number: Number of replicas.
service_name string: Service name.
termination_protection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
topic_description string: Topic description.
topic_name string: Kafka topic name.
configs list(object): Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags list(object): Topic tags.
timeouts object

id String: Resource ID composed as: project/service_name/topic_name.
ownerUserGroupId String: The user group that owns this topic.
partitions Integer: Number of partitions.
project String: Project name.
replication Integer: Number of replicas.
serviceName String: Service name.
terminationProtection Boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
topicDescription String: Topic description.
topicName String: Kafka topic name.
configs List<GetKafkaTopicConfig>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags List<GetKafkaTopicTag>: Topic tags.
timeouts GetKafkaTopicTimeouts

id string: Resource ID composed as: project/service_name/topic_name.
ownerUserGroupId string: The user group that owns this topic.
partitions number: Number of partitions.
project string: Project name.
replication number: Number of replicas.
serviceName string: Service name.
terminationProtection boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
topicDescription string: Topic description.
topicName string: Kafka topic name.
configs GetKafkaTopicConfig[]: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags GetKafkaTopicTag[]: Topic tags.
timeouts GetKafkaTopicTimeouts

id str: Resource ID composed as: project/service_name/topic_name.
owner_user_group_id str: The user group that owns this topic.
partitions int: Number of partitions.
project str: Project name.
replication int: Number of replicas.
service_name str: Service name.
termination_protection bool: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
topic_description str: Topic description.
topic_name str: Kafka topic name.
configs Sequence[GetKafkaTopicConfig]: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags Sequence[GetKafkaTopicTag]: Topic tags.
timeouts GetKafkaTopicTimeouts

id String: Resource ID composed as: project/service_name/topic_name.
ownerUserGroupId String: The user group that owns this topic.
partitions Number: Number of partitions.
project String: Project name.
replication Number: Number of replicas.
serviceName String: Service name.
terminationProtection Boolean: Client-side deletion protection that prevents the resource from being deleted by Terraform. Resource can still be deleted in the Aiven Console. The default value is false. Deprecated: Instead, use preventDestroy
Deprecated: Instead, use preventDestroy
topicDescription String: Topic description.
topicName String: Kafka topic name.
configs List<Property Map>: Advanced parameters to configure topics. Removing the block won't reset the topic configuration to default values. Instead, the topic will retain its last known configuration.
tags List<Property Map>: Topic tags.
timeouts Property Map

Supporting Types

GetKafkaTopicConfig

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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
MessageTimestampAfterMaxMs 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. Applies only for messages with timestamps later than the broker's timestamp.
MessageTimestampBeforeMaxMs 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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
MessageTimestampAfterMaxMs 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. Applies only for messages with timestamps later than the broker's timestamp.
MessageTimestampBeforeMaxMs 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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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.

cleanup_policy 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.
compression_type 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.
delete_retention_ms 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).
diskless_enable bool: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless feature enabled.
file_delete_delay_ms string: The time to wait before deleting a file from the filesystem.
flush_messages 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.
flush_ms 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.
index_interval_bytes 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.
local_retention_bytes 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. The field is required with retentionBytes.
local_retention_ms 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. The field is required with retentionMs.
max_compaction_lag_ms string: The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
max_message_bytes 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.
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 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, 4.1-IV0, 4.2 and 4.2-IV0.
message_timestamp_after_max_ms 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. Applies only for messages with timestamps later than the broker's timestamp.
message_timestamp_before_max_ms 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. Applies only for messages with timestamps earlier than the broker's timestamp.
message_timestamp_difference_max_ms 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.
message_timestamp_type string: 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 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.
min_compaction_lag_ms string: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
min_insync_replicas 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.
remote_storage_enable bool: Indicates whether tiered storage should be enabled. This is only available for services with Tiered Storage feature enabled.
retention_bytes 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.
retention_ms 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.
segment_bytes string: This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
segment_index_bytes 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.
segment_jitter_ms string: The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling.
segment_ms 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.
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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
messageTimestampAfterMaxMs 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. Applies only for messages with timestamps later than the broker's timestamp.
messageTimestampBeforeMaxMs 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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
messageTimestampAfterMaxMs 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. Applies only for messages with timestamps later than the broker's timestamp.
messageTimestampBeforeMaxMs 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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
message_timestamp_after_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. Applies only for messages with timestamps later than the broker's timestamp.
message_timestamp_before_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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless 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. The field is required with retentionBytes.
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. The field is required with retentionMs.
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, 4.1-IV0, 4.2 and 4.2-IV0.
messageTimestampAfterMaxMs 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. Applies only for messages with timestamps later than the broker's timestamp.
messageTimestampBeforeMaxMs 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. Applies only for messages with timestamps earlier than the broker's timestamp.
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. This is only available for services with Tiered Storage feature 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 segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes.
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.

GetKafkaTopicTag

Key string: Tag key.
Value string: Tag value.

Key string: Tag key.
Value string: Tag value.

key string: Tag key.
value string: Tag value.

key String: Tag key.
value String: Tag value.

key string: Tag key.
value string: Tag value.

key str: Tag key.
value str: Tag value.

key String: Tag key.
value String: Tag value.

GetKafkaTopicTimeouts

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Viewing docs for Aiven v6.58.0
published on Friday, Jul 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

aiven.getKafkaTopic

On this page

On this page

Example Usage

Using getKafkaTopic

getKafkaTopic Result

Supporting Types

GetKafkaTopicConfig

GetKafkaTopicTag

GetKafkaTopicTimeouts

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aiven.getKafkaTopic

On this page

On this page

Example Usage

Using getKafkaTopic

getKafkaTopic Result

Supporting Types

GetKafkaTopicConfig

GetKafkaTopicTag

GetKafkaTopicTimeouts

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.