digitalocean.DatabaseKafkaTopic

Coming soon!

name string

The unique name of the resource.

args DatabaseKafkaTopicArgs

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 DatabaseKafkaTopicArgs

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 DatabaseKafkaTopicArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args DatabaseKafkaTopicArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args DatabaseKafkaTopicArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ClusterId string

The ID of the source database cluster. Note: This must be a Kafka cluster.

Configs List<Pulumi.DigitalOcean.Inputs.DatabaseKafkaTopicConfig>

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

Name string

The name for the topic.

PartitionCount int

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

ReplicationFactor int

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

ClusterId string

The ID of the source database cluster. Note: This must be a Kafka cluster.

Configs []DatabaseKafkaTopicConfigArgs

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

Name string

The name for the topic.

PartitionCount int

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

ReplicationFactor int

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

clusterId String

The ID of the source database cluster. Note: This must be a Kafka cluster.

configs List<DatabaseKafkaTopicConfig>

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

name String

The name for the topic.

partitionCount Integer

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

replicationFactor Integer

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

clusterId string

The ID of the source database cluster. Note: This must be a Kafka cluster.

configs DatabaseKafkaTopicConfig[]

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

name string

The name for the topic.

partitionCount number

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

replicationFactor number

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

cluster_id str

The ID of the source database cluster. Note: This must be a Kafka cluster.

configs Sequence[DatabaseKafkaTopicConfigArgs]

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

name str

The name for the topic.

partition_count int

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

replication_factor int

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

clusterId String

The ID of the source database cluster. Note: This must be a Kafka cluster.

configs List<Property Map>

A set of advanced configuration parameters. Defaults will be set for any of the parameters that are not included. The config block is documented below.

name String

The name for the topic.

partitionCount Number

The number of partitions for the topic. Default and minimum set at 3, maximum is 2048.

replicationFactor Number

The number of nodes that topics are replicated across. Default and minimum set at 2, maximum is the number of nodes in the cluster.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

id String

The provider-assigned unique ID for this managed resource.

state String

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

id string

The provider-assigned unique ID for this managed resource.

state string

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

id str

The provider-assigned unique ID for this managed resource.

state str

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

id String

The provider-assigned unique ID for this managed resource.

state String

The current status of the topic. Possible values are 'active', 'configuring', and 'deleting'.

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.

CleanupPolicy string

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

CompressionType string

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

DeleteRetentionMs string

The amount of time, in ms, that deleted records are retained.

FileDeleteDelayMs string

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

FlushMessages string

The number of messages accumulated on a topic partition before they are flushed to disk.

FlushMs string

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

IndexIntervalBytes string

The interval, in bytes, in which entries are added to the offset index.

MaxCompactionLagMs string

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

MaxMessageBytes string

The maximum size, in bytes, of a message.

MessageDownConversionEnable bool

Determines whether down-conversion of message formats for consumers is enabled.

MessageFormatVersion string

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

MessageTimestampDifferenceMaxMs string

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

MessageTimestampType string

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

MinCleanableDirtyRatio double

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

MinCompactionLagMs string

MinInsyncReplicas int

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

Preallocate bool

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

RetentionBytes string

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

RetentionMs string

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

SegmentBytes string

The maximum size, in bytes, of a single topic log file.

SegmentIndexBytes string

The maximum size, in bytes, of the offset index.

SegmentJitterMs string

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

SegmentMs string

The maximum time, in ms, before the topic log will flush to disk.

CleanupPolicy string

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

CompressionType string

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

DeleteRetentionMs string

The amount of time, in ms, that deleted records are retained.

FileDeleteDelayMs string

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

FlushMessages string

The number of messages accumulated on a topic partition before they are flushed to disk.

FlushMs string

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

IndexIntervalBytes string

The interval, in bytes, in which entries are added to the offset index.

MaxCompactionLagMs string

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

MaxMessageBytes string

The maximum size, in bytes, of a message.

MessageDownConversionEnable bool

Determines whether down-conversion of message formats for consumers is enabled.

MessageFormatVersion string

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

MessageTimestampDifferenceMaxMs string

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

MessageTimestampType string

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

MinCleanableDirtyRatio float64

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

MinCompactionLagMs string

MinInsyncReplicas int

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

Preallocate bool

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

RetentionBytes string

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

RetentionMs string

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

SegmentBytes string

The maximum size, in bytes, of a single topic log file.

SegmentIndexBytes string

The maximum size, in bytes, of the offset index.

SegmentJitterMs string

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

SegmentMs string

The maximum time, in ms, before the topic log will flush to disk.

cleanupPolicy String

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

compressionType String

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

deleteRetentionMs String

The amount of time, in ms, that deleted records are retained.

fileDeleteDelayMs String

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

flushMessages String

The number of messages accumulated on a topic partition before they are flushed to disk.

flushMs String

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

indexIntervalBytes String

The interval, in bytes, in which entries are added to the offset index.

maxCompactionLagMs String

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

maxMessageBytes String

The maximum size, in bytes, of a message.

messageDownConversionEnable Boolean

Determines whether down-conversion of message formats for consumers is enabled.

messageFormatVersion String

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

messageTimestampDifferenceMaxMs String

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

messageTimestampType String

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

minCleanableDirtyRatio Double

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

minCompactionLagMs String

minInsyncReplicas Integer

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

preallocate Boolean

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

retentionBytes String

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

retentionMs String

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

segmentBytes String

The maximum size, in bytes, of a single topic log file.

segmentIndexBytes String

The maximum size, in bytes, of the offset index.

segmentJitterMs String

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

segmentMs String

The maximum time, in ms, before the topic log will flush to disk.

cleanupPolicy string

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

compressionType string

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

deleteRetentionMs string

The amount of time, in ms, that deleted records are retained.

fileDeleteDelayMs string

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

flushMessages string

The number of messages accumulated on a topic partition before they are flushed to disk.

flushMs string

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

indexIntervalBytes string

The interval, in bytes, in which entries are added to the offset index.

maxCompactionLagMs string

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

maxMessageBytes string

The maximum size, in bytes, of a message.

messageDownConversionEnable boolean

Determines whether down-conversion of message formats for consumers is enabled.

messageFormatVersion string

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

messageTimestampDifferenceMaxMs string

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

messageTimestampType string

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

minCleanableDirtyRatio number

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

minCompactionLagMs string

minInsyncReplicas number

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

preallocate boolean

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

retentionBytes string

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

retentionMs string

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

segmentBytes string

The maximum size, in bytes, of a single topic log file.

segmentIndexBytes string

The maximum size, in bytes, of the offset index.

segmentJitterMs string

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

segmentMs string

The maximum time, in ms, before the topic log will flush to disk.

cleanup_policy str

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

compression_type str

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

delete_retention_ms str

The amount of time, in ms, that deleted records are retained.

file_delete_delay_ms str

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

flush_messages str

The number of messages accumulated on a topic partition before they are flushed to disk.

flush_ms str

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

index_interval_bytes str

The interval, in bytes, in which entries are added to the offset index.

max_compaction_lag_ms str

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

max_message_bytes str

The maximum size, in bytes, of a message.

message_down_conversion_enable bool

Determines whether down-conversion of message formats for consumers is enabled.

message_format_version str

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

message_timestamp_difference_max_ms str

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

message_timestamp_type str

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

min_cleanable_dirty_ratio float

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

min_compaction_lag_ms str

min_insync_replicas int

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

preallocate bool

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

retention_bytes str

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

retention_ms str

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

segment_bytes str

The maximum size, in bytes, of a single topic log file.

segment_index_bytes str

The maximum size, in bytes, of the offset index.

segment_jitter_ms str

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

segment_ms str

The maximum time, in ms, before the topic log will flush to disk.

cleanupPolicy String

The topic cleanup policy that decribes whether messages should be deleted, compacted, or both when retention policies are violated. This may be one of "delete", "compact", or "compact_delete".

compressionType String

The topic compression codecs used for a given topic. This may be one of "uncompressed", "gzip", "snappy", "lz4", "producer", "zstd". "uncompressed" indicates that there is no compression and "producer" retains the original compression codec set by the producer.

deleteRetentionMs String

The amount of time, in ms, that deleted records are retained.

fileDeleteDelayMs String

The amount of time, in ms, to wait before deleting a topic log segment from the filesystem.

flushMessages String

The number of messages accumulated on a topic partition before they are flushed to disk.

flushMs String

The maximum time, in ms, that a topic is kept in memory before being flushed to disk.

indexIntervalBytes String

The interval, in bytes, in which entries are added to the offset index.

maxCompactionLagMs String

The maximum time, in ms, that a particular message will remain uncompacted. This will not apply if the compression_type is set to "uncompressed" or it is set to producer and the producer is not using compression.

maxMessageBytes String

The maximum size, in bytes, of a message.

messageDownConversionEnable Boolean

Determines whether down-conversion of message formats for consumers is enabled.

messageFormatVersion String

The version of the inter-broker protocol that will be used. This may be one of "0.8.0", "0.8.1", "0.8.2", "0.9.0", "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", "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".

messageTimestampDifferenceMaxMs String

The maximum difference, in ms, between the timestamp specific in a message and when the broker receives the message.

messageTimestampType String

Specifies which timestamp to use for the message. This may be one of "create_time" or "log_append_time".

minCleanableDirtyRatio Number

A scale between 0.0 and 1.0 which controls the frequency of the compactor. Larger values mean more frequent compactions. This is often paired with max_compaction_lag_ms to control the compactor frequency.

minCompactionLagMs String

minInsyncReplicas Number

The number of replicas that must acknowledge a write before it is considered successful. -1 is a special setting to indicate that all nodes must ack a message before a write is considered successful. Default is 1, indicating at least 1 replica must acknowledge a write to be considered successful.

preallocate Boolean

Determines whether to preallocate a file on disk when creating a new log segment within a topic.

retentionBytes String

The maximum size, in bytes, of a topic before messages are deleted. -1 is a special setting indicating that this setting has no limit.

retentionMs String

The maximum time, in ms, that a topic log file is retained before deleting it. -1 is a special setting indicating that this setting has no limit.

segmentBytes String

The maximum size, in bytes, of a single topic log file.

segmentIndexBytes String

The maximum size, in bytes, of the offset index.

segmentJitterMs String

The maximum time, in ms, subtracted from the scheduled segment disk flush time to avoid the thundering herd problem for segment flushing.

segmentMs String

The maximum time, in ms, before the topic log will flush to disk.