published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
The Kafka resource allows the creation and management of Aiven Kafka services.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var kafka1 = new Aiven.Kafka("kafka1", new()
{
Project = data.Aiven_project.Pr1.Project,
CloudName = "google-europe-west1",
Plan = "business-4",
ServiceName = "my-kafka1",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
KafkaUserConfig = new Aiven.Inputs.KafkaKafkaUserConfigArgs
{
KafkaRest = "true",
KafkaConnect = "true",
SchemaRegistry = "true",
KafkaVersion = "3.1",
Kafka = new Aiven.Inputs.KafkaKafkaUserConfigKafkaArgs
{
GroupMaxSessionTimeoutMs = "70000",
LogRetentionBytes = "1000000000",
},
PublicAccess = new Aiven.Inputs.KafkaKafkaUserConfigPublicAccessArgs
{
KafkaRest = "true",
KafkaConnect = "true",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v5/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewKafka(ctx, "kafka1", &aiven.KafkaArgs{
Project: pulumi.Any(data.Aiven_project.Pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("business-4"),
ServiceName: pulumi.String("my-kafka1"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
KafkaUserConfig: &aiven.KafkaKafkaUserConfigArgs{
KafkaRest: pulumi.String("true"),
KafkaConnect: pulumi.String("true"),
SchemaRegistry: pulumi.String("true"),
KafkaVersion: pulumi.String("3.1"),
Kafka: &aiven.KafkaKafkaUserConfigKafkaArgs{
GroupMaxSessionTimeoutMs: pulumi.String("70000"),
LogRetentionBytes: pulumi.String("1000000000"),
},
PublicAccess: &aiven.KafkaKafkaUserConfigPublicAccessArgs{
KafkaRest: pulumi.String("true"),
KafkaConnect: pulumi.String("true"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Kafka;
import com.pulumi.aiven.KafkaArgs;
import com.pulumi.aiven.inputs.KafkaKafkaUserConfigArgs;
import com.pulumi.aiven.inputs.KafkaKafkaUserConfigKafkaArgs;
import com.pulumi.aiven.inputs.KafkaKafkaUserConfigPublicAccessArgs;
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 kafka1 = new Kafka("kafka1", KafkaArgs.builder()
.project(data.aiven_project().pr1().project())
.cloudName("google-europe-west1")
.plan("business-4")
.serviceName("my-kafka1")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.kafkaUserConfig(KafkaKafkaUserConfigArgs.builder()
.kafkaRest(true)
.kafkaConnect(true)
.schemaRegistry(true)
.kafkaVersion("3.1")
.kafka(KafkaKafkaUserConfigKafkaArgs.builder()
.groupMaxSessionTimeoutMs(70000)
.logRetentionBytes(1000000000)
.build())
.publicAccess(KafkaKafkaUserConfigPublicAccessArgs.builder()
.kafkaRest(true)
.kafkaConnect(true)
.build())
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const kafka1 = new aiven.Kafka("kafka1", {
project: data.aiven_project.pr1.project,
cloudName: "google-europe-west1",
plan: "business-4",
serviceName: "my-kafka1",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
kafkaUserConfig: {
kafkaRest: "true",
kafkaConnect: "true",
schemaRegistry: "true",
kafkaVersion: "3.1",
kafka: {
groupMaxSessionTimeoutMs: "70000",
logRetentionBytes: "1000000000",
},
publicAccess: {
kafkaRest: "true",
kafkaConnect: "true",
},
},
});
import pulumi
import pulumi_aiven as aiven
kafka1 = aiven.Kafka("kafka1",
project=data["aiven_project"]["pr1"]["project"],
cloud_name="google-europe-west1",
plan="business-4",
service_name="my-kafka1",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
kafka_user_config=aiven.KafkaKafkaUserConfigArgs(
kafka_rest="true",
kafka_connect="true",
schema_registry="true",
kafka_version="3.1",
kafka=aiven.KafkaKafkaUserConfigKafkaArgs(
group_max_session_timeout_ms="70000",
log_retention_bytes="1000000000",
),
public_access=aiven.KafkaKafkaUserConfigPublicAccessArgs(
kafka_rest="true",
kafka_connect="true",
),
))
resources:
kafka1:
type: aiven:Kafka
properties:
project: ${data.aiven_project.pr1.project}
cloudName: google-europe-west1
plan: business-4
serviceName: my-kafka1
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
kafkaUserConfig:
kafkaRest: true
kafkaConnect: true
schemaRegistry: true
kafkaVersion: '3.1'
kafka:
groupMaxSessionTimeoutMs: 70000
logRetentionBytes: 1e+09
publicAccess:
kafkaRest: true
kafkaConnect: true
Create Kafka Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Kafka(name: string, args: KafkaArgs, opts?: CustomResourceOptions);@overload
def Kafka(resource_name: str,
args: KafkaArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Kafka(resource_name: str,
opts: Optional[ResourceOptions] = None,
project: Optional[str] = None,
service_name: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
plan: Optional[str] = None,
kafka: Optional[KafkaKafkaArgs] = None,
kafka_user_config: Optional[KafkaKafkaUserConfigArgs] = None,
karapace: Optional[bool] = None,
maintenance_window_dow: Optional[str] = None,
additional_disk_space: Optional[str] = None,
disk_space: Optional[str] = None,
default_acl: Optional[bool] = None,
project_vpc_id: Optional[str] = None,
service_integrations: Optional[Sequence[KafkaServiceIntegrationArgs]] = None,
cloud_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[KafkaTagArgs]] = None,
termination_protection: Optional[bool] = None)func NewKafka(ctx *Context, name string, args KafkaArgs, opts ...ResourceOption) (*Kafka, error)public Kafka(string name, KafkaArgs args, CustomResourceOptions? opts = null)type: aiven:Kafka
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 KafkaArgs
- 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 KafkaArgs
- 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 KafkaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaArgs
- 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 kafkaResource = new Aiven.Kafka("kafkaResource", new()
{
Project = "string",
ServiceName = "string",
MaintenanceWindowTime = "string",
Plan = "string",
KafkaServer = new Aiven.Inputs.KafkaKafkaArgs
{
AccessCert = "string",
AccessKey = "string",
ConnectUri = "string",
RestUri = "string",
SchemaRegistryUri = "string",
},
KafkaUserConfig = new Aiven.Inputs.KafkaKafkaUserConfigArgs
{
AdditionalBackupRegions = "string",
CustomDomain = "string",
IpFilterObjects = new[]
{
new Aiven.Inputs.KafkaKafkaUserConfigIpFilterObjectArgs
{
Description = "string",
Network = "string",
},
},
IpFilters = new[]
{
"string",
},
Kafka = new Aiven.Inputs.KafkaKafkaUserConfigKafkaArgs
{
AutoCreateTopicsEnable = "string",
CompressionType = "string",
ConnectionsMaxIdleMs = "string",
DefaultReplicationFactor = "string",
GroupInitialRebalanceDelayMs = "string",
GroupMaxSessionTimeoutMs = "string",
GroupMinSessionTimeoutMs = "string",
LogCleanerDeleteRetentionMs = "string",
LogCleanerMaxCompactionLagMs = "string",
LogCleanerMinCleanableRatio = "string",
LogCleanerMinCompactionLagMs = "string",
LogCleanupPolicy = "string",
LogFlushIntervalMessages = "string",
LogFlushIntervalMs = "string",
LogIndexIntervalBytes = "string",
LogIndexSizeMaxBytes = "string",
LogMessageDownconversionEnable = "string",
LogMessageTimestampDifferenceMaxMs = "string",
LogMessageTimestampType = "string",
LogPreallocate = "string",
LogRetentionBytes = "string",
LogRetentionHours = "string",
LogRetentionMs = "string",
LogRollJitterMs = "string",
LogRollMs = "string",
LogSegmentBytes = "string",
LogSegmentDeleteDelayMs = "string",
MaxConnectionsPerIp = "string",
MaxIncrementalFetchSessionCacheSlots = "string",
MessageMaxBytes = "string",
MinInsyncReplicas = "string",
NumPartitions = "string",
OffsetsRetentionMinutes = "string",
ProducerPurgatoryPurgeIntervalRequests = "string",
ReplicaFetchMaxBytes = "string",
ReplicaFetchResponseMaxBytes = "string",
SocketRequestMaxBytes = "string",
TransactionRemoveExpiredTransactionCleanupIntervalMs = "string",
TransactionStateLogSegmentBytes = "string",
},
KafkaAuthenticationMethods = new Aiven.Inputs.KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs
{
Certificate = "string",
Sasl = "string",
},
KafkaConnect = "string",
KafkaConnectConfig = new Aiven.Inputs.KafkaKafkaUserConfigKafkaConnectConfigArgs
{
ConnectorClientConfigOverridePolicy = "string",
ConsumerAutoOffsetReset = "string",
ConsumerFetchMaxBytes = "string",
ConsumerIsolationLevel = "string",
ConsumerMaxPartitionFetchBytes = "string",
ConsumerMaxPollIntervalMs = "string",
ConsumerMaxPollRecords = "string",
OffsetFlushIntervalMs = "string",
OffsetFlushTimeoutMs = "string",
ProducerCompressionType = "string",
ProducerMaxRequestSize = "string",
SessionTimeoutMs = "string",
},
KafkaRest = "string",
KafkaRestConfig = new Aiven.Inputs.KafkaKafkaUserConfigKafkaRestConfigArgs
{
ConsumerEnableAutoCommit = "string",
ConsumerRequestMaxBytes = "string",
ConsumerRequestTimeoutMs = "string",
ProducerAcks = "string",
ProducerLingerMs = "string",
SimpleconsumerPoolSizeMax = "string",
},
KafkaVersion = "string",
PrivateAccess = new Aiven.Inputs.KafkaKafkaUserConfigPrivateAccessArgs
{
Prometheus = "string",
},
PrivatelinkAccess = new Aiven.Inputs.KafkaKafkaUserConfigPrivatelinkAccessArgs
{
Jolokia = "string",
Kafka = "string",
KafkaConnect = "string",
KafkaRest = "string",
Prometheus = "string",
SchemaRegistry = "string",
},
PublicAccess = new Aiven.Inputs.KafkaKafkaUserConfigPublicAccessArgs
{
Kafka = "string",
KafkaConnect = "string",
KafkaRest = "string",
Prometheus = "string",
SchemaRegistry = "string",
},
SchemaRegistry = "string",
SchemaRegistryConfig = new Aiven.Inputs.KafkaKafkaUserConfigSchemaRegistryConfigArgs
{
LeaderEligibility = "string",
TopicName = "string",
},
StaticIps = "string",
},
Karapace = false,
MaintenanceWindowDow = "string",
AdditionalDiskSpace = "string",
DiskSpace = "string",
DefaultAcl = false,
ProjectVpcId = "string",
ServiceIntegrations = new[]
{
new Aiven.Inputs.KafkaServiceIntegrationArgs
{
IntegrationType = "string",
SourceServiceName = "string",
},
},
CloudName = "string",
StaticIps = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.KafkaTagArgs
{
Key = "string",
Value = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewKafka(ctx, "kafkaResource", &aiven.KafkaArgs{
Project: pulumi.String("string"),
ServiceName: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
Plan: pulumi.String("string"),
Kafka: &aiven.KafkaKafkaArgs{
AccessCert: pulumi.String("string"),
AccessKey: pulumi.String("string"),
ConnectUri: pulumi.String("string"),
RestUri: pulumi.String("string"),
SchemaRegistryUri: pulumi.String("string"),
},
KafkaUserConfig: &aiven.KafkaKafkaUserConfigArgs{
AdditionalBackupRegions: pulumi.String("string"),
CustomDomain: pulumi.String("string"),
IpFilterObjects: aiven.KafkaKafkaUserConfigIpFilterObjectArray{
&aiven.KafkaKafkaUserConfigIpFilterObjectArgs{
Description: pulumi.String("string"),
Network: pulumi.String("string"),
},
},
IpFilters: pulumi.StringArray{
pulumi.String("string"),
},
Kafka: &aiven.KafkaKafkaUserConfigKafkaArgs{
AutoCreateTopicsEnable: pulumi.String("string"),
CompressionType: pulumi.String("string"),
ConnectionsMaxIdleMs: pulumi.String("string"),
DefaultReplicationFactor: pulumi.String("string"),
GroupInitialRebalanceDelayMs: pulumi.String("string"),
GroupMaxSessionTimeoutMs: pulumi.String("string"),
GroupMinSessionTimeoutMs: pulumi.String("string"),
LogCleanerDeleteRetentionMs: pulumi.String("string"),
LogCleanerMaxCompactionLagMs: pulumi.String("string"),
LogCleanerMinCleanableRatio: pulumi.String("string"),
LogCleanerMinCompactionLagMs: pulumi.String("string"),
LogCleanupPolicy: pulumi.String("string"),
LogFlushIntervalMessages: pulumi.String("string"),
LogFlushIntervalMs: pulumi.String("string"),
LogIndexIntervalBytes: pulumi.String("string"),
LogIndexSizeMaxBytes: pulumi.String("string"),
LogMessageDownconversionEnable: pulumi.String("string"),
LogMessageTimestampDifferenceMaxMs: pulumi.String("string"),
LogMessageTimestampType: pulumi.String("string"),
LogPreallocate: pulumi.String("string"),
LogRetentionBytes: pulumi.String("string"),
LogRetentionHours: pulumi.String("string"),
LogRetentionMs: pulumi.String("string"),
LogRollJitterMs: pulumi.String("string"),
LogRollMs: pulumi.String("string"),
LogSegmentBytes: pulumi.String("string"),
LogSegmentDeleteDelayMs: pulumi.String("string"),
MaxConnectionsPerIp: pulumi.String("string"),
MaxIncrementalFetchSessionCacheSlots: pulumi.String("string"),
MessageMaxBytes: pulumi.String("string"),
MinInsyncReplicas: pulumi.String("string"),
NumPartitions: pulumi.String("string"),
OffsetsRetentionMinutes: pulumi.String("string"),
ProducerPurgatoryPurgeIntervalRequests: pulumi.String("string"),
ReplicaFetchMaxBytes: pulumi.String("string"),
ReplicaFetchResponseMaxBytes: pulumi.String("string"),
SocketRequestMaxBytes: pulumi.String("string"),
TransactionRemoveExpiredTransactionCleanupIntervalMs: pulumi.String("string"),
TransactionStateLogSegmentBytes: pulumi.String("string"),
},
KafkaAuthenticationMethods: &aiven.KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs{
Certificate: pulumi.String("string"),
Sasl: pulumi.String("string"),
},
KafkaConnect: pulumi.String("string"),
KafkaConnectConfig: &aiven.KafkaKafkaUserConfigKafkaConnectConfigArgs{
ConnectorClientConfigOverridePolicy: pulumi.String("string"),
ConsumerAutoOffsetReset: pulumi.String("string"),
ConsumerFetchMaxBytes: pulumi.String("string"),
ConsumerIsolationLevel: pulumi.String("string"),
ConsumerMaxPartitionFetchBytes: pulumi.String("string"),
ConsumerMaxPollIntervalMs: pulumi.String("string"),
ConsumerMaxPollRecords: pulumi.String("string"),
OffsetFlushIntervalMs: pulumi.String("string"),
OffsetFlushTimeoutMs: pulumi.String("string"),
ProducerCompressionType: pulumi.String("string"),
ProducerMaxRequestSize: pulumi.String("string"),
SessionTimeoutMs: pulumi.String("string"),
},
KafkaRest: pulumi.String("string"),
KafkaRestConfig: &aiven.KafkaKafkaUserConfigKafkaRestConfigArgs{
ConsumerEnableAutoCommit: pulumi.String("string"),
ConsumerRequestMaxBytes: pulumi.String("string"),
ConsumerRequestTimeoutMs: pulumi.String("string"),
ProducerAcks: pulumi.String("string"),
ProducerLingerMs: pulumi.String("string"),
SimpleconsumerPoolSizeMax: pulumi.String("string"),
},
KafkaVersion: pulumi.String("string"),
PrivateAccess: &aiven.KafkaKafkaUserConfigPrivateAccessArgs{
Prometheus: pulumi.String("string"),
},
PrivatelinkAccess: &aiven.KafkaKafkaUserConfigPrivatelinkAccessArgs{
Jolokia: pulumi.String("string"),
Kafka: pulumi.String("string"),
KafkaConnect: pulumi.String("string"),
KafkaRest: pulumi.String("string"),
Prometheus: pulumi.String("string"),
SchemaRegistry: pulumi.String("string"),
},
PublicAccess: &aiven.KafkaKafkaUserConfigPublicAccessArgs{
Kafka: pulumi.String("string"),
KafkaConnect: pulumi.String("string"),
KafkaRest: pulumi.String("string"),
Prometheus: pulumi.String("string"),
SchemaRegistry: pulumi.String("string"),
},
SchemaRegistry: pulumi.String("string"),
SchemaRegistryConfig: &aiven.KafkaKafkaUserConfigSchemaRegistryConfigArgs{
LeaderEligibility: pulumi.String("string"),
TopicName: pulumi.String("string"),
},
StaticIps: pulumi.String("string"),
},
Karapace: pulumi.Bool(false),
MaintenanceWindowDow: pulumi.String("string"),
AdditionalDiskSpace: pulumi.String("string"),
DiskSpace: pulumi.String("string"),
DefaultAcl: pulumi.Bool(false),
ProjectVpcId: pulumi.String("string"),
ServiceIntegrations: aiven.KafkaServiceIntegrationArray{
&aiven.KafkaServiceIntegrationArgs{
IntegrationType: pulumi.String("string"),
SourceServiceName: pulumi.String("string"),
},
},
CloudName: pulumi.String("string"),
StaticIps: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.KafkaTagArray{
&aiven.KafkaTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var kafkaResource = new Kafka("kafkaResource", KafkaArgs.builder()
.project("string")
.serviceName("string")
.maintenanceWindowTime("string")
.plan("string")
.kafka(KafkaKafkaArgs.builder()
.accessCert("string")
.accessKey("string")
.connectUri("string")
.restUri("string")
.schemaRegistryUri("string")
.build())
.kafkaUserConfig(KafkaKafkaUserConfigArgs.builder()
.additionalBackupRegions("string")
.customDomain("string")
.ipFilterObjects(KafkaKafkaUserConfigIpFilterObjectArgs.builder()
.description("string")
.network("string")
.build())
.ipFilters("string")
.kafka(KafkaKafkaUserConfigKafkaArgs.builder()
.autoCreateTopicsEnable("string")
.compressionType("string")
.connectionsMaxIdleMs("string")
.defaultReplicationFactor("string")
.groupInitialRebalanceDelayMs("string")
.groupMaxSessionTimeoutMs("string")
.groupMinSessionTimeoutMs("string")
.logCleanerDeleteRetentionMs("string")
.logCleanerMaxCompactionLagMs("string")
.logCleanerMinCleanableRatio("string")
.logCleanerMinCompactionLagMs("string")
.logCleanupPolicy("string")
.logFlushIntervalMessages("string")
.logFlushIntervalMs("string")
.logIndexIntervalBytes("string")
.logIndexSizeMaxBytes("string")
.logMessageDownconversionEnable("string")
.logMessageTimestampDifferenceMaxMs("string")
.logMessageTimestampType("string")
.logPreallocate("string")
.logRetentionBytes("string")
.logRetentionHours("string")
.logRetentionMs("string")
.logRollJitterMs("string")
.logRollMs("string")
.logSegmentBytes("string")
.logSegmentDeleteDelayMs("string")
.maxConnectionsPerIp("string")
.maxIncrementalFetchSessionCacheSlots("string")
.messageMaxBytes("string")
.minInsyncReplicas("string")
.numPartitions("string")
.offsetsRetentionMinutes("string")
.producerPurgatoryPurgeIntervalRequests("string")
.replicaFetchMaxBytes("string")
.replicaFetchResponseMaxBytes("string")
.socketRequestMaxBytes("string")
.transactionRemoveExpiredTransactionCleanupIntervalMs("string")
.transactionStateLogSegmentBytes("string")
.build())
.kafkaAuthenticationMethods(KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs.builder()
.certificate("string")
.sasl("string")
.build())
.kafkaConnect("string")
.kafkaConnectConfig(KafkaKafkaUserConfigKafkaConnectConfigArgs.builder()
.connectorClientConfigOverridePolicy("string")
.consumerAutoOffsetReset("string")
.consumerFetchMaxBytes("string")
.consumerIsolationLevel("string")
.consumerMaxPartitionFetchBytes("string")
.consumerMaxPollIntervalMs("string")
.consumerMaxPollRecords("string")
.offsetFlushIntervalMs("string")
.offsetFlushTimeoutMs("string")
.producerCompressionType("string")
.producerMaxRequestSize("string")
.sessionTimeoutMs("string")
.build())
.kafkaRest("string")
.kafkaRestConfig(KafkaKafkaUserConfigKafkaRestConfigArgs.builder()
.consumerEnableAutoCommit("string")
.consumerRequestMaxBytes("string")
.consumerRequestTimeoutMs("string")
.producerAcks("string")
.producerLingerMs("string")
.simpleconsumerPoolSizeMax("string")
.build())
.kafkaVersion("string")
.privateAccess(KafkaKafkaUserConfigPrivateAccessArgs.builder()
.prometheus("string")
.build())
.privatelinkAccess(KafkaKafkaUserConfigPrivatelinkAccessArgs.builder()
.jolokia("string")
.kafka("string")
.kafkaConnect("string")
.kafkaRest("string")
.prometheus("string")
.schemaRegistry("string")
.build())
.publicAccess(KafkaKafkaUserConfigPublicAccessArgs.builder()
.kafka("string")
.kafkaConnect("string")
.kafkaRest("string")
.prometheus("string")
.schemaRegistry("string")
.build())
.schemaRegistry("string")
.schemaRegistryConfig(KafkaKafkaUserConfigSchemaRegistryConfigArgs.builder()
.leaderEligibility("string")
.topicName("string")
.build())
.staticIps("string")
.build())
.karapace(false)
.maintenanceWindowDow("string")
.additionalDiskSpace("string")
.diskSpace("string")
.defaultAcl(false)
.projectVpcId("string")
.serviceIntegrations(KafkaServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cloudName("string")
.staticIps("string")
.tags(KafkaTagArgs.builder()
.key("string")
.value("string")
.build())
.terminationProtection(false)
.build());
kafka_resource = aiven.Kafka("kafkaResource",
project="string",
service_name="string",
maintenance_window_time="string",
plan="string",
kafka={
"access_cert": "string",
"access_key": "string",
"connect_uri": "string",
"rest_uri": "string",
"schema_registry_uri": "string",
},
kafka_user_config={
"additional_backup_regions": "string",
"custom_domain": "string",
"ip_filter_objects": [{
"description": "string",
"network": "string",
}],
"ip_filters": ["string"],
"kafka": {
"auto_create_topics_enable": "string",
"compression_type": "string",
"connections_max_idle_ms": "string",
"default_replication_factor": "string",
"group_initial_rebalance_delay_ms": "string",
"group_max_session_timeout_ms": "string",
"group_min_session_timeout_ms": "string",
"log_cleaner_delete_retention_ms": "string",
"log_cleaner_max_compaction_lag_ms": "string",
"log_cleaner_min_cleanable_ratio": "string",
"log_cleaner_min_compaction_lag_ms": "string",
"log_cleanup_policy": "string",
"log_flush_interval_messages": "string",
"log_flush_interval_ms": "string",
"log_index_interval_bytes": "string",
"log_index_size_max_bytes": "string",
"log_message_downconversion_enable": "string",
"log_message_timestamp_difference_max_ms": "string",
"log_message_timestamp_type": "string",
"log_preallocate": "string",
"log_retention_bytes": "string",
"log_retention_hours": "string",
"log_retention_ms": "string",
"log_roll_jitter_ms": "string",
"log_roll_ms": "string",
"log_segment_bytes": "string",
"log_segment_delete_delay_ms": "string",
"max_connections_per_ip": "string",
"max_incremental_fetch_session_cache_slots": "string",
"message_max_bytes": "string",
"min_insync_replicas": "string",
"num_partitions": "string",
"offsets_retention_minutes": "string",
"producer_purgatory_purge_interval_requests": "string",
"replica_fetch_max_bytes": "string",
"replica_fetch_response_max_bytes": "string",
"socket_request_max_bytes": "string",
"transaction_remove_expired_transaction_cleanup_interval_ms": "string",
"transaction_state_log_segment_bytes": "string",
},
"kafka_authentication_methods": {
"certificate": "string",
"sasl": "string",
},
"kafka_connect": "string",
"kafka_connect_config": {
"connector_client_config_override_policy": "string",
"consumer_auto_offset_reset": "string",
"consumer_fetch_max_bytes": "string",
"consumer_isolation_level": "string",
"consumer_max_partition_fetch_bytes": "string",
"consumer_max_poll_interval_ms": "string",
"consumer_max_poll_records": "string",
"offset_flush_interval_ms": "string",
"offset_flush_timeout_ms": "string",
"producer_compression_type": "string",
"producer_max_request_size": "string",
"session_timeout_ms": "string",
},
"kafka_rest": "string",
"kafka_rest_config": {
"consumer_enable_auto_commit": "string",
"consumer_request_max_bytes": "string",
"consumer_request_timeout_ms": "string",
"producer_acks": "string",
"producer_linger_ms": "string",
"simpleconsumer_pool_size_max": "string",
},
"kafka_version": "string",
"private_access": {
"prometheus": "string",
},
"privatelink_access": {
"jolokia": "string",
"kafka": "string",
"kafka_connect": "string",
"kafka_rest": "string",
"prometheus": "string",
"schema_registry": "string",
},
"public_access": {
"kafka": "string",
"kafka_connect": "string",
"kafka_rest": "string",
"prometheus": "string",
"schema_registry": "string",
},
"schema_registry": "string",
"schema_registry_config": {
"leader_eligibility": "string",
"topic_name": "string",
},
"static_ips": "string",
},
karapace=False,
maintenance_window_dow="string",
additional_disk_space="string",
disk_space="string",
default_acl=False,
project_vpc_id="string",
service_integrations=[{
"integration_type": "string",
"source_service_name": "string",
}],
cloud_name="string",
static_ips=["string"],
tags=[{
"key": "string",
"value": "string",
}],
termination_protection=False)
const kafkaResource = new aiven.Kafka("kafkaResource", {
project: "string",
serviceName: "string",
maintenanceWindowTime: "string",
plan: "string",
kafka: {
accessCert: "string",
accessKey: "string",
connectUri: "string",
restUri: "string",
schemaRegistryUri: "string",
},
kafkaUserConfig: {
additionalBackupRegions: "string",
customDomain: "string",
ipFilterObjects: [{
description: "string",
network: "string",
}],
ipFilters: ["string"],
kafka: {
autoCreateTopicsEnable: "string",
compressionType: "string",
connectionsMaxIdleMs: "string",
defaultReplicationFactor: "string",
groupInitialRebalanceDelayMs: "string",
groupMaxSessionTimeoutMs: "string",
groupMinSessionTimeoutMs: "string",
logCleanerDeleteRetentionMs: "string",
logCleanerMaxCompactionLagMs: "string",
logCleanerMinCleanableRatio: "string",
logCleanerMinCompactionLagMs: "string",
logCleanupPolicy: "string",
logFlushIntervalMessages: "string",
logFlushIntervalMs: "string",
logIndexIntervalBytes: "string",
logIndexSizeMaxBytes: "string",
logMessageDownconversionEnable: "string",
logMessageTimestampDifferenceMaxMs: "string",
logMessageTimestampType: "string",
logPreallocate: "string",
logRetentionBytes: "string",
logRetentionHours: "string",
logRetentionMs: "string",
logRollJitterMs: "string",
logRollMs: "string",
logSegmentBytes: "string",
logSegmentDeleteDelayMs: "string",
maxConnectionsPerIp: "string",
maxIncrementalFetchSessionCacheSlots: "string",
messageMaxBytes: "string",
minInsyncReplicas: "string",
numPartitions: "string",
offsetsRetentionMinutes: "string",
producerPurgatoryPurgeIntervalRequests: "string",
replicaFetchMaxBytes: "string",
replicaFetchResponseMaxBytes: "string",
socketRequestMaxBytes: "string",
transactionRemoveExpiredTransactionCleanupIntervalMs: "string",
transactionStateLogSegmentBytes: "string",
},
kafkaAuthenticationMethods: {
certificate: "string",
sasl: "string",
},
kafkaConnect: "string",
kafkaConnectConfig: {
connectorClientConfigOverridePolicy: "string",
consumerAutoOffsetReset: "string",
consumerFetchMaxBytes: "string",
consumerIsolationLevel: "string",
consumerMaxPartitionFetchBytes: "string",
consumerMaxPollIntervalMs: "string",
consumerMaxPollRecords: "string",
offsetFlushIntervalMs: "string",
offsetFlushTimeoutMs: "string",
producerCompressionType: "string",
producerMaxRequestSize: "string",
sessionTimeoutMs: "string",
},
kafkaRest: "string",
kafkaRestConfig: {
consumerEnableAutoCommit: "string",
consumerRequestMaxBytes: "string",
consumerRequestTimeoutMs: "string",
producerAcks: "string",
producerLingerMs: "string",
simpleconsumerPoolSizeMax: "string",
},
kafkaVersion: "string",
privateAccess: {
prometheus: "string",
},
privatelinkAccess: {
jolokia: "string",
kafka: "string",
kafkaConnect: "string",
kafkaRest: "string",
prometheus: "string",
schemaRegistry: "string",
},
publicAccess: {
kafka: "string",
kafkaConnect: "string",
kafkaRest: "string",
prometheus: "string",
schemaRegistry: "string",
},
schemaRegistry: "string",
schemaRegistryConfig: {
leaderEligibility: "string",
topicName: "string",
},
staticIps: "string",
},
karapace: false,
maintenanceWindowDow: "string",
additionalDiskSpace: "string",
diskSpace: "string",
defaultAcl: false,
projectVpcId: "string",
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cloudName: "string",
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
terminationProtection: false,
});
type: aiven:Kafka
properties:
additionalDiskSpace: string
cloudName: string
defaultAcl: false
diskSpace: string
kafka:
accessCert: string
accessKey: string
connectUri: string
restUri: string
schemaRegistryUri: string
kafkaUserConfig:
additionalBackupRegions: string
customDomain: string
ipFilterObjects:
- description: string
network: string
ipFilters:
- string
kafka:
autoCreateTopicsEnable: string
compressionType: string
connectionsMaxIdleMs: string
defaultReplicationFactor: string
groupInitialRebalanceDelayMs: string
groupMaxSessionTimeoutMs: string
groupMinSessionTimeoutMs: string
logCleanerDeleteRetentionMs: string
logCleanerMaxCompactionLagMs: string
logCleanerMinCleanableRatio: string
logCleanerMinCompactionLagMs: string
logCleanupPolicy: string
logFlushIntervalMessages: string
logFlushIntervalMs: string
logIndexIntervalBytes: string
logIndexSizeMaxBytes: string
logMessageDownconversionEnable: string
logMessageTimestampDifferenceMaxMs: string
logMessageTimestampType: string
logPreallocate: string
logRetentionBytes: string
logRetentionHours: string
logRetentionMs: string
logRollJitterMs: string
logRollMs: string
logSegmentBytes: string
logSegmentDeleteDelayMs: string
maxConnectionsPerIp: string
maxIncrementalFetchSessionCacheSlots: string
messageMaxBytes: string
minInsyncReplicas: string
numPartitions: string
offsetsRetentionMinutes: string
producerPurgatoryPurgeIntervalRequests: string
replicaFetchMaxBytes: string
replicaFetchResponseMaxBytes: string
socketRequestMaxBytes: string
transactionRemoveExpiredTransactionCleanupIntervalMs: string
transactionStateLogSegmentBytes: string
kafkaAuthenticationMethods:
certificate: string
sasl: string
kafkaConnect: string
kafkaConnectConfig:
connectorClientConfigOverridePolicy: string
consumerAutoOffsetReset: string
consumerFetchMaxBytes: string
consumerIsolationLevel: string
consumerMaxPartitionFetchBytes: string
consumerMaxPollIntervalMs: string
consumerMaxPollRecords: string
offsetFlushIntervalMs: string
offsetFlushTimeoutMs: string
producerCompressionType: string
producerMaxRequestSize: string
sessionTimeoutMs: string
kafkaRest: string
kafkaRestConfig:
consumerEnableAutoCommit: string
consumerRequestMaxBytes: string
consumerRequestTimeoutMs: string
producerAcks: string
producerLingerMs: string
simpleconsumerPoolSizeMax: string
kafkaVersion: string
privateAccess:
prometheus: string
privatelinkAccess:
jolokia: string
kafka: string
kafkaConnect: string
kafkaRest: string
prometheus: string
schemaRegistry: string
publicAccess:
kafka: string
kafkaConnect: string
kafkaRest: string
prometheus: string
schemaRegistry: string
schemaRegistry: string
schemaRegistryConfig:
leaderEligibility: string
topicName: string
staticIps: string
karapace: false
maintenanceWindowDow: string
maintenanceWindowTime: string
plan: string
project: string
projectVpcId: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
terminationProtection: false
Kafka 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 Kafka resource accepts the following input properties:
- Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Default
Acl bool - Create default wildcard Kafka ACL
- Disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Kafka
Server KafkaKafka - Kafka server provided values
- Kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- Karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations List<KafkaService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips List<string> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
List<Kafka
Tag> - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Default
Acl bool - Create default wildcard Kafka ACL
- Disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Kafka
Kafka
Kafka Args - Kafka server provided values
- Kafka
User KafkaConfig Kafka User Config Args - Kafka user configurable settings
- Karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations []KafkaService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []string - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
[]Kafka
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - default
Acl Boolean - Create default wildcard Kafka ACL
- disk
Space String - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- kafka
Kafka
Kafka - Kafka server provided values
- kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- karapace Boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations List<KafkaService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
List<Kafka
Tag> - Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - default
Acl boolean - Create default wildcard Kafka ACL
- disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- kafka
Kafka
Kafka - Kafka server provided values
- kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- karapace boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations KafkaService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips string[] - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
Kafka
Tag[] - Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project str
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service_
name str - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional_
disk_ strspace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - default_
acl bool - Create default wildcard Kafka ACL
- disk_
space str - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- kafka
Kafka
Kafka Args - Kafka server provided values
- kafka_
user_ Kafkaconfig Kafka User Config Args - Kafka user configurable settings
- karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project_
vpc_ strid - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
integrations Sequence[KafkaService Integration Args] - Service integrations to specify when creating a service. Not applied after initial service creation
- static_
ips Sequence[str] - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
Sequence[Kafka
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - default
Acl Boolean - Create default wildcard Kafka ACL
- disk
Space String - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- kafka Property Map
- Kafka server provided values
- kafka
User Property MapConfig - Kafka user configurable settings
- karapace Boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips List<String> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Outputs
All input properties are implicitly available as output properties. Additionally, the Kafka resource produces the following output properties:
- Components
List<Kafka
Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - Disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- Components
[]Kafka
Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - Disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- components
List<Kafka
Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- components
Kafka
Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- components
Sequence[Kafka
Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk_
space_ strstep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk_
space_ strused - Disk space that service is currently using
- id str
- The provider-assigned unique ID for this managed resource.
- service_
host str - The hostname of the service.
- service_
password str - Password used for connecting to the service, if applicable
- service_
port int - The port of the service
- service_
type str - Aiven internal service type code
- service_
uri str - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_
username str - Username used for connecting to the service, if applicable
- state str
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING
Look up Existing Kafka Resource
Get an existing Kafka 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?: KafkaState, opts?: CustomResourceOptions): Kafka@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_disk_space: Optional[str] = None,
cloud_name: Optional[str] = None,
components: Optional[Sequence[KafkaComponentArgs]] = None,
default_acl: Optional[bool] = None,
disk_space: Optional[str] = None,
disk_space_cap: Optional[str] = None,
disk_space_default: Optional[str] = None,
disk_space_step: Optional[str] = None,
disk_space_used: Optional[str] = None,
kafka: Optional[KafkaKafkaArgs] = None,
kafka_user_config: Optional[KafkaKafkaUserConfigArgs] = None,
karapace: Optional[bool] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
plan: Optional[str] = None,
project: Optional[str] = None,
project_vpc_id: Optional[str] = None,
service_host: Optional[str] = None,
service_integrations: Optional[Sequence[KafkaServiceIntegrationArgs]] = None,
service_name: Optional[str] = None,
service_password: Optional[str] = None,
service_port: Optional[int] = None,
service_type: Optional[str] = None,
service_uri: Optional[str] = None,
service_username: Optional[str] = None,
state: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[KafkaTagArgs]] = None,
termination_protection: Optional[bool] = None) -> Kafkafunc GetKafka(ctx *Context, name string, id IDInput, state *KafkaState, opts ...ResourceOption) (*Kafka, error)public static Kafka Get(string name, Input<string> id, KafkaState? state, CustomResourceOptions? opts = null)public static Kafka get(String name, Output<String> id, KafkaState state, CustomResourceOptions options)resources: _: type: aiven:Kafka 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.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
List<Kafka
Component> - Service component information objects
- Default
Acl bool - Create default wildcard Kafka ACL
- Disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - Disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Kafka
Server KafkaKafka - Kafka server provided values
- Kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- Karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string - The hostname of the service.
- Service
Integrations List<KafkaService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - Static
Ips List<string> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
List<Kafka
Tag> - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- Additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
[]Kafka
Component Args - Service component information objects
- Default
Acl bool - Create default wildcard Kafka ACL
- Disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - Disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Kafka
Kafka
Kafka Args - Kafka server provided values
- Kafka
User KafkaConfig Kafka User Config Args - Kafka user configurable settings
- Karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - Project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string - The hostname of the service.
- Service
Integrations []KafkaService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - Static
Ips []string - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
[]Kafka
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
List<Kafka
Component> - Service component information objects
- default
Acl Boolean - Create default wildcard Kafka ACL
- disk
Space String - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- kafka
Kafka
Kafka - Kafka server provided values
- kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- karapace Boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host String - The hostname of the service.
- service
Integrations List<KafkaService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - static
Ips List<String> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
List<Kafka
Tag> - Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk stringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Kafka
Component[] - Service component information objects
- default
Acl boolean - Create default wildcard Kafka ACL
- disk
Space string - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space stringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- kafka
Kafka
Kafka - Kafka server provided values
- kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings
- karapace boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project string
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc stringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host string - The hostname of the service.
- service
Integrations KafkaService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name string - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - static
Ips string[] - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
Kafka
Tag[] - Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional_
disk_ strspace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Sequence[Kafka
Component Args] - Service component information objects
- default_
acl bool - Create default wildcard Kafka ACL
- disk_
space str - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk_
space_ strstep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk_
space_ strused - Disk space that service is currently using
- kafka
Kafka
Kafka Args - Kafka server provided values
- kafka_
user_ Kafkaconfig Kafka User Config Args - Kafka user configurable settings
- karapace bool
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project str
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project_
vpc_ strid - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
host str - The hostname of the service.
- service_
integrations Sequence[KafkaService Integration Args] - Service integrations to specify when creating a service. Not applied after initial service creation
- service_
name str - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_
password str - Password used for connecting to the service, if applicable
- service_
port int - The port of the service
- service_
type str - Aiven internal service type code
- service_
uri str - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_
username str - Username used for connecting to the service, if applicable
- state str
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - static_
ips Sequence[str] - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
-
Sequence[Kafka
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk StringSpace - Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws,azure,dogoogle,upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components List<Property Map>
- Service component information objects
- default
Acl Boolean - Create default wildcard Kafka ACL
- disk
Space String - Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space - disk
Space StringStep - The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_spaceneeds to increment fromdisk_space_defaultby increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- kafka Property Map
- Kafka server provided values
- kafka
User Property MapConfig - Kafka user configurable settings
- karapace Boolean
- Switch the service to use Karapace for schema registry and REST proxy
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page. - project String
- Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId - Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String - Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF,REBALANCING,REBUILDINGorRUNNING - static
Ips List<String> - Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean - Prevents the service from being deleted. It is recommended to set this to
truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Supporting Types
KafkaComponent, KafkaComponentArgs
KafkaKafka, KafkaKafkaArgs
- Access
Cert string - The Kafka client certificate
- Access
Key string - The Kafka client certificate key
- Connect
Uri string - The Kafka Connect URI, if any
- Rest
Uri string - The Kafka REST URI, if any
- Schema
Registry stringUri - The Schema Registry URI, if any
- Access
Cert string - The Kafka client certificate
- Access
Key string - The Kafka client certificate key
- Connect
Uri string - The Kafka Connect URI, if any
- Rest
Uri string - The Kafka REST URI, if any
- Schema
Registry stringUri - The Schema Registry URI, if any
- access
Cert String - The Kafka client certificate
- access
Key String - The Kafka client certificate key
- connect
Uri String - The Kafka Connect URI, if any
- rest
Uri String - The Kafka REST URI, if any
- schema
Registry StringUri - The Schema Registry URI, if any
- access
Cert string - The Kafka client certificate
- access
Key string - The Kafka client certificate key
- connect
Uri string - The Kafka Connect URI, if any
- rest
Uri string - The Kafka REST URI, if any
- schema
Registry stringUri - The Schema Registry URI, if any
- access_
cert str - The Kafka client certificate
- access_
key str - The Kafka client certificate key
- connect_
uri str - The Kafka Connect URI, if any
- rest_
uri str - The Kafka REST URI, if any
- schema_
registry_ struri - The Schema Registry URI, if any
- access
Cert String - The Kafka client certificate
- access
Key String - The Kafka client certificate key
- connect
Uri String - The Kafka Connect URI, if any
- rest
Uri String - The Kafka REST URI, if any
- schema
Registry StringUri - The Schema Registry URI, if any
KafkaKafkaUserConfig, KafkaKafkaUserConfigArgs
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- Ip
Filter List<KafkaObjects Kafka User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- Kafka
Kafka
Kafka User Config Kafka - Kafka broker configuration values
- Kafka
Authentication KafkaMethods Kafka User Config Kafka Authentication Methods - Kafka authentication methods
- Kafka
Connect string - Enable Kafka Connect service
- Kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- Kafka
Rest string - Enable Kafka-REST service
- Kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- Kafka
Version string - Kafka major version
- Private
Access KafkaKafka User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access KafkaKafka User Config Privatelink Access - Allow access to selected service components through Privatelink
- Public
Access KafkaKafka User Config Public Access - Allow access to selected service ports from the public Internet
- Schema
Registry string - Enable Schema-Registry service
- Schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- Static
Ips string - Use static public IP addresses
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- Ip
Filter []KafkaObjects Kafka User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- Ip
Filters []string - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- Kafka
Kafka
Kafka User Config Kafka - Kafka broker configuration values
- Kafka
Authentication KafkaMethods Kafka User Config Kafka Authentication Methods - Kafka authentication methods
- Kafka
Connect string - Enable Kafka Connect service
- Kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- Kafka
Rest string - Enable Kafka-REST service
- Kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- Kafka
Version string - Kafka major version
- Private
Access KafkaKafka User Config Private Access - Allow access to selected service ports from private networks
- Privatelink
Access KafkaKafka User Config Privatelink Access - Allow access to selected service components through Privatelink
- Public
Access KafkaKafka User Config Public Access - Allow access to selected service ports from the public Internet
- Schema
Registry string - Enable Schema-Registry service
- Schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- Static
Ips string - Use static public IP addresses
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- ip
Filter List<KafkaObjects Kafka User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- kafka
Kafka
Kafka User Config Kafka - Kafka broker configuration values
- kafka
Authentication KafkaMethods Kafka User Config Kafka Authentication Methods - Kafka authentication methods
- kafka
Connect String - Enable Kafka Connect service
- kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka
Rest String - Enable Kafka-REST service
- kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka
Version String - Kafka major version
- private
Access KafkaKafka User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access KafkaKafka User Config Privatelink Access - Allow access to selected service components through Privatelink
- public
Access KafkaKafka User Config Public Access - Allow access to selected service ports from the public Internet
- schema
Registry String - Enable Schema-Registry service
- schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- static
Ips String - Use static public IP addresses
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication
- custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- ip
Filter KafkaObjects Kafka User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- ip
Filters string[] - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- kafka
Kafka
Kafka User Config Kafka - Kafka broker configuration values
- kafka
Authentication KafkaMethods Kafka User Config Kafka Authentication Methods - Kafka authentication methods
- kafka
Connect string - Enable Kafka Connect service
- kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka
Rest string - Enable Kafka-REST service
- kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka
Version string - Kafka major version
- private
Access KafkaKafka User Config Private Access - Allow access to selected service ports from private networks
- privatelink
Access KafkaKafka User Config Privatelink Access - Allow access to selected service components through Privatelink
- public
Access KafkaKafka User Config Public Access - Allow access to selected service ports from the public Internet
- schema
Registry string - Enable Schema-Registry service
- schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- static
Ips string - Use static public IP addresses
- additional_
backup_ strregions - Additional Cloud Regions for Backup Replication
- custom_
domain str - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- ip_
filter_ Sequence[Kafkaobjects Kafka User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- ip_
filters Sequence[str] - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- kafka
Kafka
Kafka User Config Kafka - Kafka broker configuration values
- kafka_
authentication_ Kafkamethods Kafka User Config Kafka Authentication Methods - Kafka authentication methods
- kafka_
connect str - Enable Kafka Connect service
- kafka_
connect_ Kafkaconfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka_
rest str - Enable Kafka-REST service
- kafka_
rest_ Kafkaconfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka_
version str - Kafka major version
- private_
access KafkaKafka User Config Private Access - Allow access to selected service ports from private networks
- privatelink_
access KafkaKafka User Config Privatelink Access - Allow access to selected service components through Privatelink
- public_
access KafkaKafka User Config Public Access - Allow access to selected service ports from the public Internet
- schema_
registry str - Enable Schema-Registry service
- schema_
registry_ Kafkaconfig Kafka User Config Schema Registry Config - Schema Registry configuration
- static_
ips str - Use static public IP addresses
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
- kafka Property Map
- Kafka broker configuration values
- kafka
Authentication Property MapMethods - Kafka authentication methods
- kafka
Connect String - Enable Kafka Connect service
- kafka
Connect Property MapConfig - Kafka Connect configuration values
- kafka
Rest String - Enable Kafka-REST service
- kafka
Rest Property MapConfig - Kafka REST configuration
- kafka
Version String - Kafka major version
- private
Access Property Map - Allow access to selected service ports from private networks
- privatelink
Access Property Map - Allow access to selected service components through Privatelink
- public
Access Property Map - Allow access to selected service ports from the public Internet
- schema
Registry String - Enable Schema-Registry service
- schema
Registry Property MapConfig - Schema Registry configuration
- static
Ips String - Use static public IP addresses
KafkaKafkaUserConfigIpFilterObject, KafkaKafkaUserConfigIpFilterObjectArgs
- Description string
- Network string
- Description string
- Network string
- description String
- network String
- description string
- network string
- description str
- network str
- description String
- network String
KafkaKafkaUserConfigKafka, KafkaKafkaUserConfigKafkaArgs
- Auto
Create stringTopics Enable - Compression
Type string - Connections
Max stringIdle Ms - Default
Replication stringFactor - Group
Initial stringRebalance Delay Ms - Group
Max stringSession Timeout Ms - Group
Min stringSession Timeout Ms - Log
Cleaner stringDelete Retention Ms - Log
Cleaner stringMax Compaction Lag Ms - Log
Cleaner stringMin Cleanable Ratio - Log
Cleaner stringMin Compaction Lag Ms - Log
Cleanup stringPolicy - Log
Flush stringInterval Messages - Log
Flush stringInterval Ms - Log
Index stringInterval Bytes - Log
Index stringSize Max Bytes - Log
Message stringDownconversion Enable - Log
Message stringTimestamp Difference Max Ms - Log
Message stringTimestamp Type - Log
Preallocate string - Log
Retention stringBytes - Log
Retention stringHours - Log
Retention stringMs - Log
Roll stringJitter Ms - Log
Roll stringMs - Log
Segment stringBytes - Log
Segment stringDelete Delay Ms - Max
Connections stringPer Ip - Max
Incremental stringFetch Session Cache Slots - Message
Max stringBytes - Min
Insync stringReplicas - Num
Partitions string - Offsets
Retention stringMinutes - Producer
Purgatory stringPurge Interval Requests - Replica
Fetch stringMax Bytes - Replica
Fetch stringResponse Max Bytes - Socket
Request stringMax Bytes - Transaction
Remove stringExpired Transaction Cleanup Interval Ms - Transaction
State stringLog Segment Bytes
- Auto
Create stringTopics Enable - Compression
Type string - Connections
Max stringIdle Ms - Default
Replication stringFactor - Group
Initial stringRebalance Delay Ms - Group
Max stringSession Timeout Ms - Group
Min stringSession Timeout Ms - Log
Cleaner stringDelete Retention Ms - Log
Cleaner stringMax Compaction Lag Ms - Log
Cleaner stringMin Cleanable Ratio - Log
Cleaner stringMin Compaction Lag Ms - Log
Cleanup stringPolicy - Log
Flush stringInterval Messages - Log
Flush stringInterval Ms - Log
Index stringInterval Bytes - Log
Index stringSize Max Bytes - Log
Message stringDownconversion Enable - Log
Message stringTimestamp Difference Max Ms - Log
Message stringTimestamp Type - Log
Preallocate string - Log
Retention stringBytes - Log
Retention stringHours - Log
Retention stringMs - Log
Roll stringJitter Ms - Log
Roll stringMs - Log
Segment stringBytes - Log
Segment stringDelete Delay Ms - Max
Connections stringPer Ip - Max
Incremental stringFetch Session Cache Slots - Message
Max stringBytes - Min
Insync stringReplicas - Num
Partitions string - Offsets
Retention stringMinutes - Producer
Purgatory stringPurge Interval Requests - Replica
Fetch stringMax Bytes - Replica
Fetch stringResponse Max Bytes - Socket
Request stringMax Bytes - Transaction
Remove stringExpired Transaction Cleanup Interval Ms - Transaction
State stringLog Segment Bytes
- auto
Create StringTopics Enable - compression
Type String - connections
Max StringIdle Ms - default
Replication StringFactor - group
Initial StringRebalance Delay Ms - group
Max StringSession Timeout Ms - group
Min StringSession Timeout Ms - log
Cleaner StringDelete Retention Ms - log
Cleaner StringMax Compaction Lag Ms - log
Cleaner StringMin Cleanable Ratio - log
Cleaner StringMin Compaction Lag Ms - log
Cleanup StringPolicy - log
Flush StringInterval Messages - log
Flush StringInterval Ms - log
Index StringInterval Bytes - log
Index StringSize Max Bytes - log
Message StringDownconversion Enable - log
Message StringTimestamp Difference Max Ms - log
Message StringTimestamp Type - log
Preallocate String - log
Retention StringBytes - log
Retention StringHours - log
Retention StringMs - log
Roll StringJitter Ms - log
Roll StringMs - log
Segment StringBytes - log
Segment StringDelete Delay Ms - max
Connections StringPer Ip - max
Incremental StringFetch Session Cache Slots - message
Max StringBytes - min
Insync StringReplicas - num
Partitions String - offsets
Retention StringMinutes - producer
Purgatory StringPurge Interval Requests - replica
Fetch StringMax Bytes - replica
Fetch StringResponse Max Bytes - socket
Request StringMax Bytes - transaction
Remove StringExpired Transaction Cleanup Interval Ms - transaction
State StringLog Segment Bytes
- auto
Create stringTopics Enable - compression
Type string - connections
Max stringIdle Ms - default
Replication stringFactor - group
Initial stringRebalance Delay Ms - group
Max stringSession Timeout Ms - group
Min stringSession Timeout Ms - log
Cleaner stringDelete Retention Ms - log
Cleaner stringMax Compaction Lag Ms - log
Cleaner stringMin Cleanable Ratio - log
Cleaner stringMin Compaction Lag Ms - log
Cleanup stringPolicy - log
Flush stringInterval Messages - log
Flush stringInterval Ms - log
Index stringInterval Bytes - log
Index stringSize Max Bytes - log
Message stringDownconversion Enable - log
Message stringTimestamp Difference Max Ms - log
Message stringTimestamp Type - log
Preallocate string - log
Retention stringBytes - log
Retention stringHours - log
Retention stringMs - log
Roll stringJitter Ms - log
Roll stringMs - log
Segment stringBytes - log
Segment stringDelete Delay Ms - max
Connections stringPer Ip - max
Incremental stringFetch Session Cache Slots - message
Max stringBytes - min
Insync stringReplicas - num
Partitions string - offsets
Retention stringMinutes - producer
Purgatory stringPurge Interval Requests - replica
Fetch stringMax Bytes - replica
Fetch stringResponse Max Bytes - socket
Request stringMax Bytes - transaction
Remove stringExpired Transaction Cleanup Interval Ms - transaction
State stringLog Segment Bytes
- auto_
create_ strtopics_ enable - compression_
type str - connections_
max_ stridle_ ms - default_
replication_ strfactor - group_
initial_ strrebalance_ delay_ ms - group_
max_ strsession_ timeout_ ms - group_
min_ strsession_ timeout_ ms - log_
cleaner_ strdelete_ retention_ ms - log_
cleaner_ strmax_ compaction_ lag_ ms - log_
cleaner_ strmin_ cleanable_ ratio - log_
cleaner_ strmin_ compaction_ lag_ ms - log_
cleanup_ strpolicy - log_
flush_ strinterval_ messages - log_
flush_ strinterval_ ms - log_
index_ strinterval_ bytes - log_
index_ strsize_ max_ bytes - log_
message_ strdownconversion_ enable - log_
message_ strtimestamp_ difference_ max_ ms - log_
message_ strtimestamp_ type - log_
preallocate str - log_
retention_ strbytes - log_
retention_ strhours - log_
retention_ strms - log_
roll_ strjitter_ ms - log_
roll_ strms - log_
segment_ strbytes - log_
segment_ strdelete_ delay_ ms - max_
connections_ strper_ ip - max_
incremental_ strfetch_ session_ cache_ slots - message_
max_ strbytes - min_
insync_ strreplicas - num_
partitions str - offsets_
retention_ strminutes - producer_
purgatory_ strpurge_ interval_ requests - replica_
fetch_ strmax_ bytes - replica_
fetch_ strresponse_ max_ bytes - socket_
request_ strmax_ bytes - transaction_
remove_ strexpired_ transaction_ cleanup_ interval_ ms - transaction_
state_ strlog_ segment_ bytes
- auto
Create StringTopics Enable - compression
Type String - connections
Max StringIdle Ms - default
Replication StringFactor - group
Initial StringRebalance Delay Ms - group
Max StringSession Timeout Ms - group
Min StringSession Timeout Ms - log
Cleaner StringDelete Retention Ms - log
Cleaner StringMax Compaction Lag Ms - log
Cleaner StringMin Cleanable Ratio - log
Cleaner StringMin Compaction Lag Ms - log
Cleanup StringPolicy - log
Flush StringInterval Messages - log
Flush StringInterval Ms - log
Index StringInterval Bytes - log
Index StringSize Max Bytes - log
Message StringDownconversion Enable - log
Message StringTimestamp Difference Max Ms - log
Message StringTimestamp Type - log
Preallocate String - log
Retention StringBytes - log
Retention StringHours - log
Retention StringMs - log
Roll StringJitter Ms - log
Roll StringMs - log
Segment StringBytes - log
Segment StringDelete Delay Ms - max
Connections StringPer Ip - max
Incremental StringFetch Session Cache Slots - message
Max StringBytes - min
Insync StringReplicas - num
Partitions String - offsets
Retention StringMinutes - producer
Purgatory StringPurge Interval Requests - replica
Fetch StringMax Bytes - replica
Fetch StringResponse Max Bytes - socket
Request StringMax Bytes - transaction
Remove StringExpired Transaction Cleanup Interval Ms - transaction
State StringLog Segment Bytes
KafkaKafkaUserConfigKafkaAuthenticationMethods, KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs
- Certificate string
- Sasl string
- Certificate string
- Sasl string
- certificate String
- sasl String
- certificate string
- sasl string
- certificate str
- sasl str
- certificate String
- sasl String
KafkaKafkaUserConfigKafkaConnectConfig, KafkaKafkaUserConfigKafkaConnectConfigArgs
- Connector
Client stringConfig Override Policy - Consumer
Auto stringOffset Reset - Consumer
Fetch stringMax Bytes - Consumer
Isolation stringLevel - Consumer
Max stringPartition Fetch Bytes - Consumer
Max stringPoll Interval Ms - Consumer
Max stringPoll Records - Offset
Flush stringInterval Ms - Offset
Flush stringTimeout Ms - Producer
Compression stringType - Producer
Max stringRequest Size - Session
Timeout stringMs
- Connector
Client stringConfig Override Policy - Consumer
Auto stringOffset Reset - Consumer
Fetch stringMax Bytes - Consumer
Isolation stringLevel - Consumer
Max stringPartition Fetch Bytes - Consumer
Max stringPoll Interval Ms - Consumer
Max stringPoll Records - Offset
Flush stringInterval Ms - Offset
Flush stringTimeout Ms - Producer
Compression stringType - Producer
Max stringRequest Size - Session
Timeout stringMs
- connector
Client StringConfig Override Policy - consumer
Auto StringOffset Reset - consumer
Fetch StringMax Bytes - consumer
Isolation StringLevel - consumer
Max StringPartition Fetch Bytes - consumer
Max StringPoll Interval Ms - consumer
Max StringPoll Records - offset
Flush StringInterval Ms - offset
Flush StringTimeout Ms - producer
Compression StringType - producer
Max StringRequest Size - session
Timeout StringMs
- connector
Client stringConfig Override Policy - consumer
Auto stringOffset Reset - consumer
Fetch stringMax Bytes - consumer
Isolation stringLevel - consumer
Max stringPartition Fetch Bytes - consumer
Max stringPoll Interval Ms - consumer
Max stringPoll Records - offset
Flush stringInterval Ms - offset
Flush stringTimeout Ms - producer
Compression stringType - producer
Max stringRequest Size - session
Timeout stringMs
- connector_
client_ strconfig_ override_ policy - consumer_
auto_ stroffset_ reset - consumer_
fetch_ strmax_ bytes - consumer_
isolation_ strlevel - consumer_
max_ strpartition_ fetch_ bytes - consumer_
max_ strpoll_ interval_ ms - consumer_
max_ strpoll_ records - offset_
flush_ strinterval_ ms - offset_
flush_ strtimeout_ ms - producer_
compression_ strtype - producer_
max_ strrequest_ size - session_
timeout_ strms
- connector
Client StringConfig Override Policy - consumer
Auto StringOffset Reset - consumer
Fetch StringMax Bytes - consumer
Isolation StringLevel - consumer
Max StringPartition Fetch Bytes - consumer
Max StringPoll Interval Ms - consumer
Max StringPoll Records - offset
Flush StringInterval Ms - offset
Flush StringTimeout Ms - producer
Compression StringType - producer
Max StringRequest Size - session
Timeout StringMs
KafkaKafkaUserConfigKafkaRestConfig, KafkaKafkaUserConfigKafkaRestConfigArgs
- Consumer
Enable stringAuto Commit - Consumer
Request stringMax Bytes - Consumer
Request stringTimeout Ms - Producer
Acks string - Producer
Linger stringMs - Simpleconsumer
Pool stringSize Max
- Consumer
Enable stringAuto Commit - Consumer
Request stringMax Bytes - Consumer
Request stringTimeout Ms - Producer
Acks string - Producer
Linger stringMs - Simpleconsumer
Pool stringSize Max
- consumer
Enable StringAuto Commit - consumer
Request StringMax Bytes - consumer
Request StringTimeout Ms - producer
Acks String - producer
Linger StringMs - simpleconsumer
Pool StringSize Max
- consumer
Enable stringAuto Commit - consumer
Request stringMax Bytes - consumer
Request stringTimeout Ms - producer
Acks string - producer
Linger stringMs - simpleconsumer
Pool stringSize Max
- consumer
Enable StringAuto Commit - consumer
Request StringMax Bytes - consumer
Request StringTimeout Ms - producer
Acks String - producer
Linger StringMs - simpleconsumer
Pool StringSize Max
KafkaKafkaUserConfigPrivateAccess, KafkaKafkaUserConfigPrivateAccessArgs
- Prometheus string
- Prometheus string
- prometheus String
- prometheus string
- prometheus str
- prometheus String
KafkaKafkaUserConfigPrivatelinkAccess, KafkaKafkaUserConfigPrivatelinkAccessArgs
- Jolokia string
- Kafka string
- Kafka server provided values
- Kafka
Connect string - Kafka
Rest string - Prometheus string
- Schema
Registry string
- Jolokia string
- Kafka string
- Kafka server provided values
- Kafka
Connect string - Kafka
Rest string - Prometheus string
- Schema
Registry string
- jolokia String
- kafka String
- Kafka server provided values
- kafka
Connect String - kafka
Rest String - prometheus String
- schema
Registry String
- jolokia string
- kafka string
- Kafka server provided values
- kafka
Connect string - kafka
Rest string - prometheus string
- schema
Registry string
- jolokia str
- kafka str
- Kafka server provided values
- kafka_
connect str - kafka_
rest str - prometheus str
- schema_
registry str
- jolokia String
- kafka String
- Kafka server provided values
- kafka
Connect String - kafka
Rest String - prometheus String
- schema
Registry String
KafkaKafkaUserConfigPublicAccess, KafkaKafkaUserConfigPublicAccessArgs
- Kafka string
- Kafka server provided values
- Kafka
Connect string - Kafka
Rest string - Prometheus string
- Schema
Registry string
- Kafka string
- Kafka server provided values
- Kafka
Connect string - Kafka
Rest string - Prometheus string
- Schema
Registry string
- kafka String
- Kafka server provided values
- kafka
Connect String - kafka
Rest String - prometheus String
- schema
Registry String
- kafka string
- Kafka server provided values
- kafka
Connect string - kafka
Rest string - prometheus string
- schema
Registry string
- kafka str
- Kafka server provided values
- kafka_
connect str - kafka_
rest str - prometheus str
- schema_
registry str
- kafka String
- Kafka server provided values
- kafka
Connect String - kafka
Rest String - prometheus String
- schema
Registry String
KafkaKafkaUserConfigSchemaRegistryConfig, KafkaKafkaUserConfigSchemaRegistryConfigArgs
- Leader
Eligibility string - Topic
Name string
- Leader
Eligibility string - Topic
Name string
- leader
Eligibility String - topic
Name String
- leader
Eligibility string - topic
Name string
- leader_
eligibility str - topic_
name str
- leader
Eligibility String - topic
Name String
KafkaServiceIntegration, KafkaServiceIntegrationArgs
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica - Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica - Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica - source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica - source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration. The only supported value at the moment is
read_replica - source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica - source
Service StringName - Name of the source service
KafkaTag, KafkaTagArgs
Import
$ pulumi import aiven:index/kafka:Kafka kafka1 project/service_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
aivenTerraform Provider.
published on Monday, Mar 9, 2026 by Pulumi
