aiven.KafkaTopic
Explore with Pulumi AI
Creates and manages an Aiven for Apache Kafka® topic.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleTopic = new aiven.KafkaTopic("example_topic", {
project: exampleProject.project,
serviceName: exampleKafka.serviceName,
topicName: "example-topic",
partitions: 5,
replication: 3,
terminationProtection: true,
config: {
flushMs: "10",
cleanupPolicy: "compact,delete",
},
ownerUserGroupId: example.groupId,
});
import pulumi
import pulumi_aiven as aiven
example_topic = aiven.KafkaTopic("example_topic",
project=example_project["project"],
service_name=example_kafka["serviceName"],
topic_name="example-topic",
partitions=5,
replication=3,
termination_protection=True,
config={
"flush_ms": "10",
"cleanup_policy": "compact,delete",
},
owner_user_group_id=example["groupId"])
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.NewKafkaTopic(ctx, "example_topic", &aiven.KafkaTopicArgs{
Project: pulumi.Any(exampleProject.Project),
ServiceName: pulumi.Any(exampleKafka.ServiceName),
TopicName: pulumi.String("example-topic"),
Partitions: pulumi.Int(5),
Replication: pulumi.Int(3),
TerminationProtection: pulumi.Bool(true),
Config: &aiven.KafkaTopicConfigArgs{
FlushMs: pulumi.String("10"),
CleanupPolicy: pulumi.String("compact,delete"),
},
OwnerUserGroupId: pulumi.Any(example.GroupId),
})
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 exampleTopic = new Aiven.KafkaTopic("example_topic", new()
{
Project = exampleProject.Project,
ServiceName = exampleKafka.ServiceName,
TopicName = "example-topic",
Partitions = 5,
Replication = 3,
TerminationProtection = true,
Config = new Aiven.Inputs.KafkaTopicConfigArgs
{
FlushMs = "10",
CleanupPolicy = "compact,delete",
},
OwnerUserGroupId = example.GroupId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaTopic;
import com.pulumi.aiven.KafkaTopicArgs;
import com.pulumi.aiven.inputs.KafkaTopicConfigArgs;
import java.util.List;
import java.util.ArrayList;
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) {
var exampleTopic = new KafkaTopic("exampleTopic", KafkaTopicArgs.builder()
.project(exampleProject.project())
.serviceName(exampleKafka.serviceName())
.topicName("example-topic")
.partitions(5)
.replication(3)
.terminationProtection(true)
.config(KafkaTopicConfigArgs.builder()
.flushMs("10")
.cleanupPolicy("compact,delete")
.build())
.ownerUserGroupId(example.groupId())
.build());
}
}
resources:
exampleTopic:
type: aiven:KafkaTopic
name: example_topic
properties:
project: ${exampleProject.project}
serviceName: ${exampleKafka.serviceName}
topicName: example-topic
partitions: 5
replication: 3
terminationProtection: true
config:
flushMs: 10
cleanupPolicy: compact,delete
ownerUserGroupId: ${example.groupId}
Create KafkaTopic Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KafkaTopic(name: string, args: KafkaTopicArgs, opts?: CustomResourceOptions);
@overload
def KafkaTopic(resource_name: str,
args: KafkaTopicArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KafkaTopic(resource_name: str,
opts: Optional[ResourceOptions] = None,
partitions: Optional[int] = None,
project: Optional[str] = None,
replication: Optional[int] = None,
service_name: Optional[str] = None,
topic_name: Optional[str] = None,
config: Optional[KafkaTopicConfigArgs] = None,
owner_user_group_id: Optional[str] = None,
tags: Optional[Sequence[KafkaTopicTagArgs]] = None,
termination_protection: Optional[bool] = None,
topic_description: Optional[str] = None)
func NewKafkaTopic(ctx *Context, name string, args KafkaTopicArgs, opts ...ResourceOption) (*KafkaTopic, error)
public KafkaTopic(string name, KafkaTopicArgs args, CustomResourceOptions? opts = null)
public KafkaTopic(String name, KafkaTopicArgs args)
public KafkaTopic(String name, KafkaTopicArgs args, CustomResourceOptions options)
type: aiven:KafkaTopic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args KafkaTopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args KafkaTopicArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args KafkaTopicArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaTopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaTopicArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var kafkaTopicResource = new Aiven.KafkaTopic("kafkaTopicResource", new()
{
Partitions = 0,
Project = "string",
Replication = 0,
ServiceName = "string",
TopicName = "string",
Config = new Aiven.Inputs.KafkaTopicConfigArgs
{
CleanupPolicy = "string",
CompressionType = "string",
DeleteRetentionMs = "string",
FileDeleteDelayMs = "string",
FlushMessages = "string",
FlushMs = "string",
IndexIntervalBytes = "string",
LocalRetentionBytes = "string",
LocalRetentionMs = "string",
MaxCompactionLagMs = "string",
MaxMessageBytes = "string",
MessageDownconversionEnable = false,
MessageFormatVersion = "string",
MessageTimestampDifferenceMaxMs = "string",
MessageTimestampType = "string",
MinCleanableDirtyRatio = 0,
MinCompactionLagMs = "string",
MinInsyncReplicas = "string",
Preallocate = false,
RemoteStorageEnable = false,
RetentionBytes = "string",
RetentionMs = "string",
SegmentBytes = "string",
SegmentIndexBytes = "string",
SegmentJitterMs = "string",
SegmentMs = "string",
UncleanLeaderElectionEnable = false,
},
OwnerUserGroupId = "string",
Tags = new[]
{
new Aiven.Inputs.KafkaTopicTagArgs
{
Key = "string",
Value = "string",
},
},
TerminationProtection = false,
TopicDescription = "string",
});
example, err := aiven.NewKafkaTopic(ctx, "kafkaTopicResource", &aiven.KafkaTopicArgs{
Partitions: pulumi.Int(0),
Project: pulumi.String("string"),
Replication: pulumi.Int(0),
ServiceName: pulumi.String("string"),
TopicName: pulumi.String("string"),
Config: &aiven.KafkaTopicConfigArgs{
CleanupPolicy: pulumi.String("string"),
CompressionType: pulumi.String("string"),
DeleteRetentionMs: pulumi.String("string"),
FileDeleteDelayMs: pulumi.String("string"),
FlushMessages: pulumi.String("string"),
FlushMs: pulumi.String("string"),
IndexIntervalBytes: pulumi.String("string"),
LocalRetentionBytes: pulumi.String("string"),
LocalRetentionMs: pulumi.String("string"),
MaxCompactionLagMs: pulumi.String("string"),
MaxMessageBytes: pulumi.String("string"),
MessageDownconversionEnable: pulumi.Bool(false),
MessageFormatVersion: pulumi.String("string"),
MessageTimestampDifferenceMaxMs: pulumi.String("string"),
MessageTimestampType: pulumi.String("string"),
MinCleanableDirtyRatio: pulumi.Float64(0),
MinCompactionLagMs: pulumi.String("string"),
MinInsyncReplicas: pulumi.String("string"),
Preallocate: pulumi.Bool(false),
RemoteStorageEnable: pulumi.Bool(false),
RetentionBytes: pulumi.String("string"),
RetentionMs: pulumi.String("string"),
SegmentBytes: pulumi.String("string"),
SegmentIndexBytes: pulumi.String("string"),
SegmentJitterMs: pulumi.String("string"),
SegmentMs: pulumi.String("string"),
UncleanLeaderElectionEnable: pulumi.Bool(false),
},
OwnerUserGroupId: pulumi.String("string"),
Tags: aiven.KafkaTopicTagArray{
&aiven.KafkaTopicTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
TopicDescription: pulumi.String("string"),
})
var kafkaTopicResource = new KafkaTopic("kafkaTopicResource", KafkaTopicArgs.builder()
.partitions(0)
.project("string")
.replication(0)
.serviceName("string")
.topicName("string")
.config(KafkaTopicConfigArgs.builder()
.cleanupPolicy("string")
.compressionType("string")
.deleteRetentionMs("string")
.fileDeleteDelayMs("string")
.flushMessages("string")
.flushMs("string")
.indexIntervalBytes("string")
.localRetentionBytes("string")
.localRetentionMs("string")
.maxCompactionLagMs("string")
.maxMessageBytes("string")
.messageDownconversionEnable(false)
.messageFormatVersion("string")
.messageTimestampDifferenceMaxMs("string")
.messageTimestampType("string")
.minCleanableDirtyRatio(0.0)
.minCompactionLagMs("string")
.minInsyncReplicas("string")
.preallocate(false)
.remoteStorageEnable(false)
.retentionBytes("string")
.retentionMs("string")
.segmentBytes("string")
.segmentIndexBytes("string")
.segmentJitterMs("string")
.segmentMs("string")
.uncleanLeaderElectionEnable(false)
.build())
.ownerUserGroupId("string")
.tags(KafkaTopicTagArgs.builder()
.key("string")
.value("string")
.build())
.terminationProtection(false)
.topicDescription("string")
.build());
kafka_topic_resource = aiven.KafkaTopic("kafkaTopicResource",
partitions=0,
project="string",
replication=0,
service_name="string",
topic_name="string",
config={
"cleanup_policy": "string",
"compression_type": "string",
"delete_retention_ms": "string",
"file_delete_delay_ms": "string",
"flush_messages": "string",
"flush_ms": "string",
"index_interval_bytes": "string",
"local_retention_bytes": "string",
"local_retention_ms": "string",
"max_compaction_lag_ms": "string",
"max_message_bytes": "string",
"message_downconversion_enable": False,
"message_format_version": "string",
"message_timestamp_difference_max_ms": "string",
"message_timestamp_type": "string",
"min_cleanable_dirty_ratio": 0,
"min_compaction_lag_ms": "string",
"min_insync_replicas": "string",
"preallocate": False,
"remote_storage_enable": False,
"retention_bytes": "string",
"retention_ms": "string",
"segment_bytes": "string",
"segment_index_bytes": "string",
"segment_jitter_ms": "string",
"segment_ms": "string",
"unclean_leader_election_enable": False,
},
owner_user_group_id="string",
tags=[{
"key": "string",
"value": "string",
}],
termination_protection=False,
topic_description="string")
const kafkaTopicResource = new aiven.KafkaTopic("kafkaTopicResource", {
partitions: 0,
project: "string",
replication: 0,
serviceName: "string",
topicName: "string",
config: {
cleanupPolicy: "string",
compressionType: "string",
deleteRetentionMs: "string",
fileDeleteDelayMs: "string",
flushMessages: "string",
flushMs: "string",
indexIntervalBytes: "string",
localRetentionBytes: "string",
localRetentionMs: "string",
maxCompactionLagMs: "string",
maxMessageBytes: "string",
messageDownconversionEnable: false,
messageFormatVersion: "string",
messageTimestampDifferenceMaxMs: "string",
messageTimestampType: "string",
minCleanableDirtyRatio: 0,
minCompactionLagMs: "string",
minInsyncReplicas: "string",
preallocate: false,
remoteStorageEnable: false,
retentionBytes: "string",
retentionMs: "string",
segmentBytes: "string",
segmentIndexBytes: "string",
segmentJitterMs: "string",
segmentMs: "string",
uncleanLeaderElectionEnable: false,
},
ownerUserGroupId: "string",
tags: [{
key: "string",
value: "string",
}],
terminationProtection: false,
topicDescription: "string",
});
type: aiven:KafkaTopic
properties:
config:
cleanupPolicy: string
compressionType: string
deleteRetentionMs: string
fileDeleteDelayMs: string
flushMessages: string
flushMs: string
indexIntervalBytes: string
localRetentionBytes: string
localRetentionMs: string
maxCompactionLagMs: string
maxMessageBytes: string
messageDownconversionEnable: false
messageFormatVersion: string
messageTimestampDifferenceMaxMs: string
messageTimestampType: string
minCleanableDirtyRatio: 0
minCompactionLagMs: string
minInsyncReplicas: string
preallocate: false
remoteStorageEnable: false
retentionBytes: string
retentionMs: string
segmentBytes: string
segmentIndexBytes: string
segmentJitterMs: string
segmentMs: string
uncleanLeaderElectionEnable: false
ownerUserGroupId: string
partitions: 0
project: string
replication: 0
serviceName: string
tags:
- key: string
value: string
terminationProtection: false
topicDescription: string
topicName: string
KafkaTopic Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The KafkaTopic resource accepts the following input properties:
- Partitions int
- The number of partitions to create in the topic.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Replication int
- The replication factor for the topic.
- Service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- Config
Kafka
Topic Config - Advanced parameters to configure topics.
- Owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- List<Kafka
Topic Tag> - Tags for the topic.
- Termination
Protection bool - Topic
Description string - The description of the topic
- Partitions int
- The number of partitions to create in the topic.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Replication int
- The replication factor for the topic.
- Service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- Config
Kafka
Topic Config Args - Advanced parameters to configure topics.
- Owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- []Kafka
Topic Tag Args - Tags for the topic.
- Termination
Protection bool - Topic
Description string - The description of the topic
- partitions Integer
- The number of partitions to create in the topic.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication Integer
- The replication factor for the topic.
- service
Name String - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- topic
Name String - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config - Advanced parameters to configure topics.
- owner
User StringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- List<Kafka
Topic Tag> - Tags for the topic.
- termination
Protection Boolean - topic
Description String - The description of the topic
- partitions number
- The number of partitions to create in the topic.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication number
- The replication factor for the topic.
- service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config - Advanced parameters to configure topics.
- owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- Kafka
Topic Tag[] - Tags for the topic.
- termination
Protection boolean - topic
Description string - The description of the topic
- partitions int
- The number of partitions to create in the topic.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication int
- The replication factor for the topic.
- service_
name str - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- topic_
name str - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config Args - Advanced parameters to configure topics.
- owner_
user_ strgroup_ id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- Sequence[Kafka
Topic Tag Args] - Tags for the topic.
- termination_
protection bool - topic_
description str - The description of the topic
- partitions Number
- The number of partitions to create in the topic.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication Number
- The replication factor for the topic.
- service
Name String - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- topic
Name String - The name of the topic. Changing this property forces recreation of the resource.
- config Property Map
- Advanced parameters to configure topics.
- owner
User StringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- List<Property Map>
- Tags for the topic.
- termination
Protection Boolean - topic
Description String - The description of the topic
Outputs
All input properties are implicitly available as output properties. Additionally, the KafkaTopic resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing KafkaTopic Resource
Get an existing KafkaTopic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: KafkaTopicState, opts?: CustomResourceOptions): KafkaTopic
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[KafkaTopicConfigArgs] = None,
owner_user_group_id: Optional[str] = None,
partitions: Optional[int] = None,
project: Optional[str] = None,
replication: Optional[int] = None,
service_name: Optional[str] = None,
tags: Optional[Sequence[KafkaTopicTagArgs]] = None,
termination_protection: Optional[bool] = None,
topic_description: Optional[str] = None,
topic_name: Optional[str] = None) -> KafkaTopic
func GetKafkaTopic(ctx *Context, name string, id IDInput, state *KafkaTopicState, opts ...ResourceOption) (*KafkaTopic, error)
public static KafkaTopic Get(string name, Input<string> id, KafkaTopicState? state, CustomResourceOptions? opts = null)
public static KafkaTopic get(String name, Output<String> id, KafkaTopicState state, CustomResourceOptions options)
resources: _: type: aiven:KafkaTopic get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
Kafka
Topic Config - Advanced parameters to configure topics.
- Owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- Partitions int
- The number of partitions to create in the topic.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Replication int
- The replication factor for the topic.
- Service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- List<Kafka
Topic Tag> - Tags for the topic.
- Termination
Protection bool - Topic
Description string - The description of the topic
- Topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- Config
Kafka
Topic Config Args - Advanced parameters to configure topics.
- Owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- Partitions int
- The number of partitions to create in the topic.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Replication int
- The replication factor for the topic.
- Service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- []Kafka
Topic Tag Args - Tags for the topic.
- Termination
Protection bool - Topic
Description string - The description of the topic
- Topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config - Advanced parameters to configure topics.
- owner
User StringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- partitions Integer
- The number of partitions to create in the topic.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication Integer
- The replication factor for the topic.
- service
Name String - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- List<Kafka
Topic Tag> - Tags for the topic.
- termination
Protection Boolean - topic
Description String - The description of the topic
- topic
Name String - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config - Advanced parameters to configure topics.
- owner
User stringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- partitions number
- The number of partitions to create in the topic.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication number
- The replication factor for the topic.
- service
Name string - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Kafka
Topic Tag[] - Tags for the topic.
- termination
Protection boolean - topic
Description string - The description of the topic
- topic
Name string - The name of the topic. Changing this property forces recreation of the resource.
- config
Kafka
Topic Config Args - Advanced parameters to configure topics.
- owner_
user_ strgroup_ id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- partitions int
- The number of partitions to create in the topic.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication int
- The replication factor for the topic.
- service_
name str - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- Sequence[Kafka
Topic Tag Args] - Tags for the topic.
- termination_
protection bool - topic_
description str - The description of the topic
- topic_
name str - The name of the topic. Changing this property forces recreation of the resource.
- config Property Map
- Advanced parameters to configure topics.
- owner
User StringGroup Id - The ID of the user group that owns the topic. Assigning ownership to decentralize topic management is part of Aiven for Apache Kafka® governance.
- partitions Number
- The number of partitions to create in the topic.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- replication Number
- The replication factor for the topic.
- service
Name String - The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- List<Property Map>
- Tags for the topic.
- termination
Protection Boolean - topic
Description String - The description of the topic
- topic
Name String - The name of the topic. Changing this property forces recreation of the resource.
Supporting Types
KafkaTopicConfig, KafkaTopicConfigArgs
- 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
anddelete
. - 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
andzstd
. - Delete
Retention stringMs - 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).
- File
Delete stringDelay Ms - 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 stringBytes - 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 stringBytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- Local
Retention stringMs - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- Max
Compaction stringLag Ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- Max
Message stringBytes - 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 boolEnable - 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 stringVersion - 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. 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
and4.1-IV0
. - Message
Timestamp stringDifference Max Ms - 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 stringType - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - Min
Cleanable doubleDirty Ratio - 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 stringLag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- Min
Insync stringReplicas - 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 boolEnable - Indicates whether tiered storage should be 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 size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- Segment
Index stringBytes - 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 stringMs - 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 boolElection Enable - 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
anddelete
. - 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
andzstd
. - Delete
Retention stringMs - 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).
- File
Delete stringDelay Ms - 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 stringBytes - 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 stringBytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- Local
Retention stringMs - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- Max
Compaction stringLag Ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- Max
Message stringBytes - 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 boolEnable - 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 stringVersion - 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. 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
and4.1-IV0
. - Message
Timestamp stringDifference Max Ms - 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 stringType - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - Min
Cleanable float64Dirty Ratio - 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 stringLag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- Min
Insync stringReplicas - 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 boolEnable - Indicates whether tiered storage should be 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 size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- Segment
Index stringBytes - 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 stringMs - 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 boolElection Enable - 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
anddelete
. - 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
andzstd
. - delete
Retention StringMs - 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).
- file
Delete StringDelay Ms - 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 StringBytes - 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 StringBytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- local
Retention StringMs - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- max
Compaction StringLag Ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- max
Message StringBytes - 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 BooleanEnable - 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 StringVersion - 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. 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
and4.1-IV0
. - message
Timestamp StringDifference Max Ms - 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 StringType - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - min
Cleanable DoubleDirty Ratio - 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 StringLag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- min
Insync StringReplicas - 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.
- remote
Storage BooleanEnable - Indicates whether tiered storage should be 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 size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- segment
Index StringBytes - 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 StringMs - 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 BooleanElection Enable - 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
anddelete
. - 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
andzstd
. - delete
Retention stringMs - 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).
- file
Delete stringDelay Ms - 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 stringBytes - 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 stringBytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- local
Retention stringMs - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- max
Compaction stringLag Ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- max
Message stringBytes - 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 booleanEnable - 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 stringVersion - 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. 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
and4.1-IV0
. - message
Timestamp stringDifference Max Ms - 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 stringType - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - min
Cleanable numberDirty Ratio - 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 stringLag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- min
Insync stringReplicas - 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.
- remote
Storage booleanEnable - Indicates whether tiered storage should be 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 size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- segment
Index stringBytes - 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 stringMs - 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 booleanElection Enable - 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
anddelete
. - 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
andzstd
. - delete_
retention_ strms - 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).
- file_
delete_ strdelay_ ms - 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_ strbytes - 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_ strbytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- local_
retention_ strms - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- max_
compaction_ strlag_ ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- max_
message_ strbytes - 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_ boolenable - 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_ strversion - 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. 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
and4.1-IV0
. - message_
timestamp_ strdifference_ max_ ms - 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_ strtype - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - min_
cleanable_ floatdirty_ ratio - 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_ strlag_ ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- min_
insync_ strreplicas - 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_ boolenable - Indicates whether tiered storage should be enabled.
- retention_
bytes str - This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes.
- retention_
ms str - This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.
- segment_
bytes str - This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- segment_
index_ strbytes - 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_ strms - 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_ boolelection_ enable - 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
anddelete
. - 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
andzstd
. - delete
Retention StringMs - 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).
- file
Delete StringDelay Ms - 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 StringBytes - 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 StringBytes - This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1.
- local
Retention StringMs - This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1.
- max
Compaction StringLag Ms - The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted.
- max
Message StringBytes - 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 BooleanEnable - 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 StringVersion - 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. 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
and4.1-IV0
. - message
Timestamp StringDifference Max Ms - 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 StringType - Define whether the timestamp in the message is message create time or log append time. The possible values are
CreateTime
andLogAppendTime
. - min
Cleanable NumberDirty Ratio - 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 StringLag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
- min
Insync StringReplicas - 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.
- remote
Storage BooleanEnable - Indicates whether tiered storage should be 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 size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting.
- segment
Index StringBytes - 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 StringMs - 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 BooleanElection Enable - 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.
KafkaTopicTag, KafkaTopicTagArgs
Import
$ pulumi import aiven:index/kafkaTopic:KafkaTopic example_topic PROJECT/SERVICE_NAME/TOPIC_NAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.