Docs Home
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
aiven.Kafka
Explore with Pulumi AI
Creates and manages an Aiven for Apache Kafka® service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleKafka = new aiven.Kafka("example_kafka", {
project: exampleProject.project,
cloudName: "google-europe-west1",
plan: "business-4",
serviceName: "example-kafka",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
kafkaUserConfig: {
kafkaRest: true,
kafkaConnect: true,
schemaRegistry: true,
kafkaVersion: "3.8",
kafka: {
groupMaxSessionTimeoutMs: 70000,
logRetentionBytes: 1000000000,
},
publicAccess: {
kafkaRest: true,
kafkaConnect: true,
},
},
});
import pulumi
import pulumi_aiven as aiven
example_kafka = aiven.Kafka("example_kafka",
project=example_project["project"],
cloud_name="google-europe-west1",
plan="business-4",
service_name="example-kafka",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
kafka_user_config={
"kafka_rest": True,
"kafka_connect": True,
"schema_registry": True,
"kafka_version": "3.8",
"kafka": {
"group_max_session_timeout_ms": 70000,
"log_retention_bytes": 1000000000,
},
"public_access": {
"kafka_rest": True,
"kafka_connect": True,
},
})
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewKafka(ctx, "example_kafka", &aiven.KafkaArgs{
Project: pulumi.Any(exampleProject.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("business-4"),
ServiceName: pulumi.String("example-kafka"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
KafkaUserConfig: &aiven.KafkaKafkaUserConfigArgs{
KafkaRest: pulumi.Bool(true),
KafkaConnect: pulumi.Bool(true),
SchemaRegistry: pulumi.Bool(true),
KafkaVersion: pulumi.String("3.8"),
Kafka: &aiven.KafkaKafkaUserConfigKafkaArgs{
GroupMaxSessionTimeoutMs: pulumi.Int(70000),
LogRetentionBytes: pulumi.Int(1000000000),
},
PublicAccess: &aiven.KafkaKafkaUserConfigPublicAccessArgs{
KafkaRest: pulumi.Bool(true),
KafkaConnect: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var exampleKafka = new Aiven.Kafka("example_kafka", new()
{
Project = exampleProject.Project,
CloudName = "google-europe-west1",
Plan = "business-4",
ServiceName = "example-kafka",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
KafkaUserConfig = new Aiven.Inputs.KafkaKafkaUserConfigArgs
{
KafkaRest = true,
KafkaConnect = true,
SchemaRegistry = true,
KafkaVersion = "3.8",
Kafka = new Aiven.Inputs.KafkaKafkaUserConfigKafkaArgs
{
GroupMaxSessionTimeoutMs = 70000,
LogRetentionBytes = 1000000000,
},
PublicAccess = new Aiven.Inputs.KafkaKafkaUserConfigPublicAccessArgs
{
KafkaRest = true,
KafkaConnect = true,
},
},
});
});
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 exampleKafka = new Kafka("exampleKafka", KafkaArgs.builder()
.project(exampleProject.project())
.cloudName("google-europe-west1")
.plan("business-4")
.serviceName("example-kafka")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.kafkaUserConfig(KafkaKafkaUserConfigArgs.builder()
.kafkaRest(true)
.kafkaConnect(true)
.schemaRegistry(true)
.kafkaVersion("3.8")
.kafka(KafkaKafkaUserConfigKafkaArgs.builder()
.groupMaxSessionTimeoutMs(70000)
.logRetentionBytes(1000000000)
.build())
.publicAccess(KafkaKafkaUserConfigPublicAccessArgs.builder()
.kafkaRest(true)
.kafkaConnect(true)
.build())
.build())
.build());
}
}
resources:
exampleKafka:
type: aiven:Kafka
name: example_kafka
properties:
project: ${exampleProject.project}
cloudName: google-europe-west1
plan: business-4
serviceName: example-kafka
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
kafkaUserConfig:
kafkaRest: true
kafkaConnect: true
schemaRegistry: true
kafkaVersion: '3.8'
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,
plan: Optional[str] = None,
service_name: Optional[str] = None,
project: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
default_acl: Optional[bool] = None,
kafkas: Optional[Sequence[KafkaKafkaArgs]] = None,
karapace: Optional[bool] = None,
maintenance_window_dow: Optional[str] = None,
additional_disk_space: Optional[str] = None,
disk_space: Optional[str] = None,
kafka_user_config: Optional[KafkaKafkaUserConfigArgs] = 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,
tech_emails: Optional[Sequence[KafkaTechEmailArgs]] = 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()
{
Plan = "string",
ServiceName = "string",
Project = "string",
MaintenanceWindowTime = "string",
DefaultAcl = false,
KafkaServer = new[]
{
new Aiven.Inputs.KafkaKafkaArgs
{
AccessCert = "string",
AccessKey = "string",
ConnectUri = "string",
RestUri = "string",
SchemaRegistryUri = "string",
Uris = new[]
{
"string",
},
},
},
MaintenanceWindowDow = "string",
AdditionalDiskSpace = "string",
KafkaUserConfig = new Aiven.Inputs.KafkaKafkaUserConfigArgs
{
AivenKafkaTopicMessages = false,
CustomDomain = "string",
FollowerFetching = new Aiven.Inputs.KafkaKafkaUserConfigFollowerFetchingArgs
{
Enabled = false,
},
IpFilterObjects = new[]
{
new Aiven.Inputs.KafkaKafkaUserConfigIpFilterObjectArgs
{
Network = "string",
Description = "string",
},
},
IpFilterStrings = new[]
{
"string",
},
Kafka = new Aiven.Inputs.KafkaKafkaUserConfigKafkaArgs
{
AutoCreateTopicsEnable = false,
CompressionType = "string",
ConnectionsMaxIdleMs = 0,
DefaultReplicationFactor = 0,
GroupInitialRebalanceDelayMs = 0,
GroupMaxSessionTimeoutMs = 0,
GroupMinSessionTimeoutMs = 0,
LogCleanerDeleteRetentionMs = 0,
LogCleanerMaxCompactionLagMs = 0,
LogCleanerMinCleanableRatio = 0,
LogCleanerMinCompactionLagMs = 0,
LogCleanupPolicy = "string",
LogFlushIntervalMessages = 0,
LogFlushIntervalMs = 0,
LogIndexIntervalBytes = 0,
LogIndexSizeMaxBytes = 0,
LogLocalRetentionBytes = 0,
LogLocalRetentionMs = 0,
LogMessageDownconversionEnable = false,
LogMessageTimestampDifferenceMaxMs = 0,
LogMessageTimestampType = "string",
LogPreallocate = false,
LogRetentionBytes = 0,
LogRetentionHours = 0,
LogRetentionMs = 0,
LogRollJitterMs = 0,
LogRollMs = 0,
LogSegmentBytes = 0,
LogSegmentDeleteDelayMs = 0,
MaxConnectionsPerIp = 0,
MaxIncrementalFetchSessionCacheSlots = 0,
MessageMaxBytes = 0,
MinInsyncReplicas = 0,
NumPartitions = 0,
OffsetsRetentionMinutes = 0,
ProducerPurgatoryPurgeIntervalRequests = 0,
ReplicaFetchMaxBytes = 0,
ReplicaFetchResponseMaxBytes = 0,
SaslOauthbearerExpectedAudience = "string",
SaslOauthbearerExpectedIssuer = "string",
SaslOauthbearerJwksEndpointUrl = "string",
SaslOauthbearerSubClaimName = "string",
SocketRequestMaxBytes = 0,
TransactionPartitionVerificationEnable = false,
TransactionRemoveExpiredTransactionCleanupIntervalMs = 0,
TransactionStateLogSegmentBytes = 0,
},
KafkaAuthenticationMethods = new Aiven.Inputs.KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs
{
Certificate = false,
Sasl = false,
},
KafkaConnect = false,
KafkaConnectConfig = new Aiven.Inputs.KafkaKafkaUserConfigKafkaConnectConfigArgs
{
ConnectorClientConfigOverridePolicy = "string",
ConsumerAutoOffsetReset = "string",
ConsumerFetchMaxBytes = 0,
ConsumerIsolationLevel = "string",
ConsumerMaxPartitionFetchBytes = 0,
ConsumerMaxPollIntervalMs = 0,
ConsumerMaxPollRecords = 0,
OffsetFlushIntervalMs = 0,
OffsetFlushTimeoutMs = 0,
ProducerBatchSize = 0,
ProducerBufferMemory = 0,
ProducerCompressionType = "string",
ProducerLingerMs = 0,
ProducerMaxRequestSize = 0,
ScheduledRebalanceMaxDelayMs = 0,
SessionTimeoutMs = 0,
},
KafkaConnectSecretProviders = new[]
{
new Aiven.Inputs.KafkaKafkaUserConfigKafkaConnectSecretProviderArgs
{
Name = "string",
Aws = new Aiven.Inputs.KafkaKafkaUserConfigKafkaConnectSecretProviderAwsArgs
{
AuthMethod = "string",
Region = "string",
AccessKey = "string",
SecretKey = "string",
},
Vault = new Aiven.Inputs.KafkaKafkaUserConfigKafkaConnectSecretProviderVaultArgs
{
Address = "string",
AuthMethod = "string",
EngineVersion = 0,
PrefixPathDepth = 0,
Token = "string",
},
},
},
KafkaRest = false,
KafkaRestAuthorization = false,
KafkaRestConfig = new Aiven.Inputs.KafkaKafkaUserConfigKafkaRestConfigArgs
{
ConsumerEnableAutoCommit = false,
ConsumerIdleDisconnectTimeout = 0,
ConsumerRequestMaxBytes = 0,
ConsumerRequestTimeoutMs = 0,
NameStrategy = "string",
NameStrategyValidation = false,
ProducerAcks = "string",
ProducerCompressionType = "string",
ProducerLingerMs = 0,
ProducerMaxRequestSize = 0,
SimpleconsumerPoolSizeMax = 0,
},
KafkaSaslMechanisms = new Aiven.Inputs.KafkaKafkaUserConfigKafkaSaslMechanismsArgs
{
Plain = false,
ScramSha256 = false,
ScramSha512 = false,
},
KafkaVersion = "string",
LetsencryptSaslPrivatelink = false,
PrivateAccess = new Aiven.Inputs.KafkaKafkaUserConfigPrivateAccessArgs
{
Kafka = false,
KafkaConnect = false,
KafkaRest = false,
Prometheus = false,
SchemaRegistry = false,
},
PrivatelinkAccess = new Aiven.Inputs.KafkaKafkaUserConfigPrivatelinkAccessArgs
{
Jolokia = false,
Kafka = false,
KafkaConnect = false,
KafkaRest = false,
Prometheus = false,
SchemaRegistry = false,
},
PublicAccess = new Aiven.Inputs.KafkaKafkaUserConfigPublicAccessArgs
{
Kafka = false,
KafkaConnect = false,
KafkaRest = false,
Prometheus = false,
SchemaRegistry = false,
},
SchemaRegistry = false,
SchemaRegistryConfig = new Aiven.Inputs.KafkaKafkaUserConfigSchemaRegistryConfigArgs
{
LeaderEligibility = false,
RetriableErrorsSilenced = false,
SchemaReaderStrictMode = false,
TopicName = "string",
},
ServiceLog = false,
SingleZone = new Aiven.Inputs.KafkaKafkaUserConfigSingleZoneArgs
{
Enabled = false,
},
StaticIps = false,
TieredStorage = new Aiven.Inputs.KafkaKafkaUserConfigTieredStorageArgs
{
Enabled = 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",
},
},
TechEmails = new[]
{
new Aiven.Inputs.KafkaTechEmailArgs
{
Email = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewKafka(ctx, "kafkaResource", &aiven.KafkaArgs{
Plan: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Project: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
DefaultAcl: pulumi.Bool(false),
Kafkas: aiven.KafkaKafkaArray{
&aiven.KafkaKafkaArgs{
AccessCert: pulumi.String("string"),
AccessKey: pulumi.String("string"),
ConnectUri: pulumi.String("string"),
RestUri: pulumi.String("string"),
SchemaRegistryUri: pulumi.String("string"),
Uris: pulumi.StringArray{
pulumi.String("string"),
},
},
},
MaintenanceWindowDow: pulumi.String("string"),
AdditionalDiskSpace: pulumi.String("string"),
KafkaUserConfig: &aiven.KafkaKafkaUserConfigArgs{
AivenKafkaTopicMessages: pulumi.Bool(false),
CustomDomain: pulumi.String("string"),
FollowerFetching: &aiven.KafkaKafkaUserConfigFollowerFetchingArgs{
Enabled: pulumi.Bool(false),
},
IpFilterObjects: aiven.KafkaKafkaUserConfigIpFilterObjectArray{
&aiven.KafkaKafkaUserConfigIpFilterObjectArgs{
Network: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
IpFilterStrings: pulumi.StringArray{
pulumi.String("string"),
},
Kafka: &aiven.KafkaKafkaUserConfigKafkaArgs{
AutoCreateTopicsEnable: pulumi.Bool(false),
CompressionType: pulumi.String("string"),
ConnectionsMaxIdleMs: pulumi.Int(0),
DefaultReplicationFactor: pulumi.Int(0),
GroupInitialRebalanceDelayMs: pulumi.Int(0),
GroupMaxSessionTimeoutMs: pulumi.Int(0),
GroupMinSessionTimeoutMs: pulumi.Int(0),
LogCleanerDeleteRetentionMs: pulumi.Int(0),
LogCleanerMaxCompactionLagMs: pulumi.Int(0),
LogCleanerMinCleanableRatio: pulumi.Float64(0),
LogCleanerMinCompactionLagMs: pulumi.Int(0),
LogCleanupPolicy: pulumi.String("string"),
LogFlushIntervalMessages: pulumi.Int(0),
LogFlushIntervalMs: pulumi.Int(0),
LogIndexIntervalBytes: pulumi.Int(0),
LogIndexSizeMaxBytes: pulumi.Int(0),
LogLocalRetentionBytes: pulumi.Int(0),
LogLocalRetentionMs: pulumi.Int(0),
LogMessageDownconversionEnable: pulumi.Bool(false),
LogMessageTimestampDifferenceMaxMs: pulumi.Int(0),
LogMessageTimestampType: pulumi.String("string"),
LogPreallocate: pulumi.Bool(false),
LogRetentionBytes: pulumi.Int(0),
LogRetentionHours: pulumi.Int(0),
LogRetentionMs: pulumi.Int(0),
LogRollJitterMs: pulumi.Int(0),
LogRollMs: pulumi.Int(0),
LogSegmentBytes: pulumi.Int(0),
LogSegmentDeleteDelayMs: pulumi.Int(0),
MaxConnectionsPerIp: pulumi.Int(0),
MaxIncrementalFetchSessionCacheSlots: pulumi.Int(0),
MessageMaxBytes: pulumi.Int(0),
MinInsyncReplicas: pulumi.Int(0),
NumPartitions: pulumi.Int(0),
OffsetsRetentionMinutes: pulumi.Int(0),
ProducerPurgatoryPurgeIntervalRequests: pulumi.Int(0),
ReplicaFetchMaxBytes: pulumi.Int(0),
ReplicaFetchResponseMaxBytes: pulumi.Int(0),
SaslOauthbearerExpectedAudience: pulumi.String("string"),
SaslOauthbearerExpectedIssuer: pulumi.String("string"),
SaslOauthbearerJwksEndpointUrl: pulumi.String("string"),
SaslOauthbearerSubClaimName: pulumi.String("string"),
SocketRequestMaxBytes: pulumi.Int(0),
TransactionPartitionVerificationEnable: pulumi.Bool(false),
TransactionRemoveExpiredTransactionCleanupIntervalMs: pulumi.Int(0),
TransactionStateLogSegmentBytes: pulumi.Int(0),
},
KafkaAuthenticationMethods: &aiven.KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs{
Certificate: pulumi.Bool(false),
Sasl: pulumi.Bool(false),
},
KafkaConnect: pulumi.Bool(false),
KafkaConnectConfig: &aiven.KafkaKafkaUserConfigKafkaConnectConfigArgs{
ConnectorClientConfigOverridePolicy: pulumi.String("string"),
ConsumerAutoOffsetReset: pulumi.String("string"),
ConsumerFetchMaxBytes: pulumi.Int(0),
ConsumerIsolationLevel: pulumi.String("string"),
ConsumerMaxPartitionFetchBytes: pulumi.Int(0),
ConsumerMaxPollIntervalMs: pulumi.Int(0),
ConsumerMaxPollRecords: pulumi.Int(0),
OffsetFlushIntervalMs: pulumi.Int(0),
OffsetFlushTimeoutMs: pulumi.Int(0),
ProducerBatchSize: pulumi.Int(0),
ProducerBufferMemory: pulumi.Int(0),
ProducerCompressionType: pulumi.String("string"),
ProducerLingerMs: pulumi.Int(0),
ProducerMaxRequestSize: pulumi.Int(0),
ScheduledRebalanceMaxDelayMs: pulumi.Int(0),
SessionTimeoutMs: pulumi.Int(0),
},
KafkaConnectSecretProviders: aiven.KafkaKafkaUserConfigKafkaConnectSecretProviderArray{
&aiven.KafkaKafkaUserConfigKafkaConnectSecretProviderArgs{
Name: pulumi.String("string"),
Aws: &aiven.KafkaKafkaUserConfigKafkaConnectSecretProviderAwsArgs{
AuthMethod: pulumi.String("string"),
Region: pulumi.String("string"),
AccessKey: pulumi.String("string"),
SecretKey: pulumi.String("string"),
},
Vault: &aiven.KafkaKafkaUserConfigKafkaConnectSecretProviderVaultArgs{
Address: pulumi.String("string"),
AuthMethod: pulumi.String("string"),
EngineVersion: pulumi.Int(0),
PrefixPathDepth: pulumi.Int(0),
Token: pulumi.String("string"),
},
},
},
KafkaRest: pulumi.Bool(false),
KafkaRestAuthorization: pulumi.Bool(false),
KafkaRestConfig: &aiven.KafkaKafkaUserConfigKafkaRestConfigArgs{
ConsumerEnableAutoCommit: pulumi.Bool(false),
ConsumerIdleDisconnectTimeout: pulumi.Int(0),
ConsumerRequestMaxBytes: pulumi.Int(0),
ConsumerRequestTimeoutMs: pulumi.Int(0),
NameStrategy: pulumi.String("string"),
NameStrategyValidation: pulumi.Bool(false),
ProducerAcks: pulumi.String("string"),
ProducerCompressionType: pulumi.String("string"),
ProducerLingerMs: pulumi.Int(0),
ProducerMaxRequestSize: pulumi.Int(0),
SimpleconsumerPoolSizeMax: pulumi.Int(0),
},
KafkaSaslMechanisms: &aiven.KafkaKafkaUserConfigKafkaSaslMechanismsArgs{
Plain: pulumi.Bool(false),
ScramSha256: pulumi.Bool(false),
ScramSha512: pulumi.Bool(false),
},
KafkaVersion: pulumi.String("string"),
LetsencryptSaslPrivatelink: pulumi.Bool(false),
PrivateAccess: &aiven.KafkaKafkaUserConfigPrivateAccessArgs{
Kafka: pulumi.Bool(false),
KafkaConnect: pulumi.Bool(false),
KafkaRest: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
SchemaRegistry: pulumi.Bool(false),
},
PrivatelinkAccess: &aiven.KafkaKafkaUserConfigPrivatelinkAccessArgs{
Jolokia: pulumi.Bool(false),
Kafka: pulumi.Bool(false),
KafkaConnect: pulumi.Bool(false),
KafkaRest: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
SchemaRegistry: pulumi.Bool(false),
},
PublicAccess: &aiven.KafkaKafkaUserConfigPublicAccessArgs{
Kafka: pulumi.Bool(false),
KafkaConnect: pulumi.Bool(false),
KafkaRest: pulumi.Bool(false),
Prometheus: pulumi.Bool(false),
SchemaRegistry: pulumi.Bool(false),
},
SchemaRegistry: pulumi.Bool(false),
SchemaRegistryConfig: &aiven.KafkaKafkaUserConfigSchemaRegistryConfigArgs{
LeaderEligibility: pulumi.Bool(false),
RetriableErrorsSilenced: pulumi.Bool(false),
SchemaReaderStrictMode: pulumi.Bool(false),
TopicName: pulumi.String("string"),
},
ServiceLog: pulumi.Bool(false),
SingleZone: &aiven.KafkaKafkaUserConfigSingleZoneArgs{
Enabled: pulumi.Bool(false),
},
StaticIps: pulumi.Bool(false),
TieredStorage: &aiven.KafkaKafkaUserConfigTieredStorageArgs{
Enabled: 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"),
},
},
TechEmails: aiven.KafkaTechEmailArray{
&aiven.KafkaTechEmailArgs{
Email: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var kafkaResource = new Kafka("kafkaResource", KafkaArgs.builder()
.plan("string")
.serviceName("string")
.project("string")
.maintenanceWindowTime("string")
.defaultAcl(false)
.kafkas(KafkaKafkaArgs.builder()
.accessCert("string")
.accessKey("string")
.connectUri("string")
.restUri("string")
.schemaRegistryUri("string")
.uris("string")
.build())
.maintenanceWindowDow("string")
.additionalDiskSpace("string")
.kafkaUserConfig(KafkaKafkaUserConfigArgs.builder()
.aivenKafkaTopicMessages(false)
.customDomain("string")
.followerFetching(KafkaKafkaUserConfigFollowerFetchingArgs.builder()
.enabled(false)
.build())
.ipFilterObjects(KafkaKafkaUserConfigIpFilterObjectArgs.builder()
.network("string")
.description("string")
.build())
.ipFilterStrings("string")
.kafka(KafkaKafkaUserConfigKafkaArgs.builder()
.autoCreateTopicsEnable(false)
.compressionType("string")
.connectionsMaxIdleMs(0)
.defaultReplicationFactor(0)
.groupInitialRebalanceDelayMs(0)
.groupMaxSessionTimeoutMs(0)
.groupMinSessionTimeoutMs(0)
.logCleanerDeleteRetentionMs(0)
.logCleanerMaxCompactionLagMs(0)
.logCleanerMinCleanableRatio(0)
.logCleanerMinCompactionLagMs(0)
.logCleanupPolicy("string")
.logFlushIntervalMessages(0)
.logFlushIntervalMs(0)
.logIndexIntervalBytes(0)
.logIndexSizeMaxBytes(0)
.logLocalRetentionBytes(0)
.logLocalRetentionMs(0)
.logMessageDownconversionEnable(false)
.logMessageTimestampDifferenceMaxMs(0)
.logMessageTimestampType("string")
.logPreallocate(false)
.logRetentionBytes(0)
.logRetentionHours(0)
.logRetentionMs(0)
.logRollJitterMs(0)
.logRollMs(0)
.logSegmentBytes(0)
.logSegmentDeleteDelayMs(0)
.maxConnectionsPerIp(0)
.maxIncrementalFetchSessionCacheSlots(0)
.messageMaxBytes(0)
.minInsyncReplicas(0)
.numPartitions(0)
.offsetsRetentionMinutes(0)
.producerPurgatoryPurgeIntervalRequests(0)
.replicaFetchMaxBytes(0)
.replicaFetchResponseMaxBytes(0)
.saslOauthbearerExpectedAudience("string")
.saslOauthbearerExpectedIssuer("string")
.saslOauthbearerJwksEndpointUrl("string")
.saslOauthbearerSubClaimName("string")
.socketRequestMaxBytes(0)
.transactionPartitionVerificationEnable(false)
.transactionRemoveExpiredTransactionCleanupIntervalMs(0)
.transactionStateLogSegmentBytes(0)
.build())
.kafkaAuthenticationMethods(KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs.builder()
.certificate(false)
.sasl(false)
.build())
.kafkaConnect(false)
.kafkaConnectConfig(KafkaKafkaUserConfigKafkaConnectConfigArgs.builder()
.connectorClientConfigOverridePolicy("string")
.consumerAutoOffsetReset("string")
.consumerFetchMaxBytes(0)
.consumerIsolationLevel("string")
.consumerMaxPartitionFetchBytes(0)
.consumerMaxPollIntervalMs(0)
.consumerMaxPollRecords(0)
.offsetFlushIntervalMs(0)
.offsetFlushTimeoutMs(0)
.producerBatchSize(0)
.producerBufferMemory(0)
.producerCompressionType("string")
.producerLingerMs(0)
.producerMaxRequestSize(0)
.scheduledRebalanceMaxDelayMs(0)
.sessionTimeoutMs(0)
.build())
.kafkaConnectSecretProviders(KafkaKafkaUserConfigKafkaConnectSecretProviderArgs.builder()
.name("string")
.aws(KafkaKafkaUserConfigKafkaConnectSecretProviderAwsArgs.builder()
.authMethod("string")
.region("string")
.accessKey("string")
.secretKey("string")
.build())
.vault(KafkaKafkaUserConfigKafkaConnectSecretProviderVaultArgs.builder()
.address("string")
.authMethod("string")
.engineVersion(0)
.prefixPathDepth(0)
.token("string")
.build())
.build())
.kafkaRest(false)
.kafkaRestAuthorization(false)
.kafkaRestConfig(KafkaKafkaUserConfigKafkaRestConfigArgs.builder()
.consumerEnableAutoCommit(false)
.consumerIdleDisconnectTimeout(0)
.consumerRequestMaxBytes(0)
.consumerRequestTimeoutMs(0)
.nameStrategy("string")
.nameStrategyValidation(false)
.producerAcks("string")
.producerCompressionType("string")
.producerLingerMs(0)
.producerMaxRequestSize(0)
.simpleconsumerPoolSizeMax(0)
.build())
.kafkaSaslMechanisms(KafkaKafkaUserConfigKafkaSaslMechanismsArgs.builder()
.plain(false)
.scramSha256(false)
.scramSha512(false)
.build())
.kafkaVersion("string")
.letsencryptSaslPrivatelink(false)
.privateAccess(KafkaKafkaUserConfigPrivateAccessArgs.builder()
.kafka(false)
.kafkaConnect(false)
.kafkaRest(false)
.prometheus(false)
.schemaRegistry(false)
.build())
.privatelinkAccess(KafkaKafkaUserConfigPrivatelinkAccessArgs.builder()
.jolokia(false)
.kafka(false)
.kafkaConnect(false)
.kafkaRest(false)
.prometheus(false)
.schemaRegistry(false)
.build())
.publicAccess(KafkaKafkaUserConfigPublicAccessArgs.builder()
.kafka(false)
.kafkaConnect(false)
.kafkaRest(false)
.prometheus(false)
.schemaRegistry(false)
.build())
.schemaRegistry(false)
.schemaRegistryConfig(KafkaKafkaUserConfigSchemaRegistryConfigArgs.builder()
.leaderEligibility(false)
.retriableErrorsSilenced(false)
.schemaReaderStrictMode(false)
.topicName("string")
.build())
.serviceLog(false)
.singleZone(KafkaKafkaUserConfigSingleZoneArgs.builder()
.enabled(false)
.build())
.staticIps(false)
.tieredStorage(KafkaKafkaUserConfigTieredStorageArgs.builder()
.enabled(false)
.build())
.build())
.projectVpcId("string")
.serviceIntegrations(KafkaServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cloudName("string")
.staticIps("string")
.tags(KafkaTagArgs.builder()
.key("string")
.value("string")
.build())
.techEmails(KafkaTechEmailArgs.builder()
.email("string")
.build())
.terminationProtection(false)
.build());
kafka_resource = aiven.Kafka("kafkaResource",
plan="string",
service_name="string",
project="string",
maintenance_window_time="string",
default_acl=False,
kafkas=[{
"access_cert": "string",
"access_key": "string",
"connect_uri": "string",
"rest_uri": "string",
"schema_registry_uri": "string",
"uris": ["string"],
}],
maintenance_window_dow="string",
additional_disk_space="string",
kafka_user_config={
"aiven_kafka_topic_messages": False,
"custom_domain": "string",
"follower_fetching": {
"enabled": False,
},
"ip_filter_objects": [{
"network": "string",
"description": "string",
}],
"ip_filter_strings": ["string"],
"kafka": {
"auto_create_topics_enable": False,
"compression_type": "string",
"connections_max_idle_ms": 0,
"default_replication_factor": 0,
"group_initial_rebalance_delay_ms": 0,
"group_max_session_timeout_ms": 0,
"group_min_session_timeout_ms": 0,
"log_cleaner_delete_retention_ms": 0,
"log_cleaner_max_compaction_lag_ms": 0,
"log_cleaner_min_cleanable_ratio": 0,
"log_cleaner_min_compaction_lag_ms": 0,
"log_cleanup_policy": "string",
"log_flush_interval_messages": 0,
"log_flush_interval_ms": 0,
"log_index_interval_bytes": 0,
"log_index_size_max_bytes": 0,
"log_local_retention_bytes": 0,
"log_local_retention_ms": 0,
"log_message_downconversion_enable": False,
"log_message_timestamp_difference_max_ms": 0,
"log_message_timestamp_type": "string",
"log_preallocate": False,
"log_retention_bytes": 0,
"log_retention_hours": 0,
"log_retention_ms": 0,
"log_roll_jitter_ms": 0,
"log_roll_ms": 0,
"log_segment_bytes": 0,
"log_segment_delete_delay_ms": 0,
"max_connections_per_ip": 0,
"max_incremental_fetch_session_cache_slots": 0,
"message_max_bytes": 0,
"min_insync_replicas": 0,
"num_partitions": 0,
"offsets_retention_minutes": 0,
"producer_purgatory_purge_interval_requests": 0,
"replica_fetch_max_bytes": 0,
"replica_fetch_response_max_bytes": 0,
"sasl_oauthbearer_expected_audience": "string",
"sasl_oauthbearer_expected_issuer": "string",
"sasl_oauthbearer_jwks_endpoint_url": "string",
"sasl_oauthbearer_sub_claim_name": "string",
"socket_request_max_bytes": 0,
"transaction_partition_verification_enable": False,
"transaction_remove_expired_transaction_cleanup_interval_ms": 0,
"transaction_state_log_segment_bytes": 0,
},
"kafka_authentication_methods": {
"certificate": False,
"sasl": False,
},
"kafka_connect": False,
"kafka_connect_config": {
"connector_client_config_override_policy": "string",
"consumer_auto_offset_reset": "string",
"consumer_fetch_max_bytes": 0,
"consumer_isolation_level": "string",
"consumer_max_partition_fetch_bytes": 0,
"consumer_max_poll_interval_ms": 0,
"consumer_max_poll_records": 0,
"offset_flush_interval_ms": 0,
"offset_flush_timeout_ms": 0,
"producer_batch_size": 0,
"producer_buffer_memory": 0,
"producer_compression_type": "string",
"producer_linger_ms": 0,
"producer_max_request_size": 0,
"scheduled_rebalance_max_delay_ms": 0,
"session_timeout_ms": 0,
},
"kafka_connect_secret_providers": [{
"name": "string",
"aws": {
"auth_method": "string",
"region": "string",
"access_key": "string",
"secret_key": "string",
},
"vault": {
"address": "string",
"auth_method": "string",
"engine_version": 0,
"prefix_path_depth": 0,
"token": "string",
},
}],
"kafka_rest": False,
"kafka_rest_authorization": False,
"kafka_rest_config": {
"consumer_enable_auto_commit": False,
"consumer_idle_disconnect_timeout": 0,
"consumer_request_max_bytes": 0,
"consumer_request_timeout_ms": 0,
"name_strategy": "string",
"name_strategy_validation": False,
"producer_acks": "string",
"producer_compression_type": "string",
"producer_linger_ms": 0,
"producer_max_request_size": 0,
"simpleconsumer_pool_size_max": 0,
},
"kafka_sasl_mechanisms": {
"plain": False,
"scram_sha256": False,
"scram_sha512": False,
},
"kafka_version": "string",
"letsencrypt_sasl_privatelink": False,
"private_access": {
"kafka": False,
"kafka_connect": False,
"kafka_rest": False,
"prometheus": False,
"schema_registry": False,
},
"privatelink_access": {
"jolokia": False,
"kafka": False,
"kafka_connect": False,
"kafka_rest": False,
"prometheus": False,
"schema_registry": False,
},
"public_access": {
"kafka": False,
"kafka_connect": False,
"kafka_rest": False,
"prometheus": False,
"schema_registry": False,
},
"schema_registry": False,
"schema_registry_config": {
"leader_eligibility": False,
"retriable_errors_silenced": False,
"schema_reader_strict_mode": False,
"topic_name": "string",
},
"service_log": False,
"single_zone": {
"enabled": False,
},
"static_ips": False,
"tiered_storage": {
"enabled": 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",
}],
tech_emails=[{
"email": "string",
}],
termination_protection=False)
const kafkaResource = new aiven.Kafka("kafkaResource", {
plan: "string",
serviceName: "string",
project: "string",
maintenanceWindowTime: "string",
defaultAcl: false,
kafkas: [{
accessCert: "string",
accessKey: "string",
connectUri: "string",
restUri: "string",
schemaRegistryUri: "string",
uris: ["string"],
}],
maintenanceWindowDow: "string",
additionalDiskSpace: "string",
kafkaUserConfig: {
aivenKafkaTopicMessages: false,
customDomain: "string",
followerFetching: {
enabled: false,
},
ipFilterObjects: [{
network: "string",
description: "string",
}],
ipFilterStrings: ["string"],
kafka: {
autoCreateTopicsEnable: false,
compressionType: "string",
connectionsMaxIdleMs: 0,
defaultReplicationFactor: 0,
groupInitialRebalanceDelayMs: 0,
groupMaxSessionTimeoutMs: 0,
groupMinSessionTimeoutMs: 0,
logCleanerDeleteRetentionMs: 0,
logCleanerMaxCompactionLagMs: 0,
logCleanerMinCleanableRatio: 0,
logCleanerMinCompactionLagMs: 0,
logCleanupPolicy: "string",
logFlushIntervalMessages: 0,
logFlushIntervalMs: 0,
logIndexIntervalBytes: 0,
logIndexSizeMaxBytes: 0,
logLocalRetentionBytes: 0,
logLocalRetentionMs: 0,
logMessageDownconversionEnable: false,
logMessageTimestampDifferenceMaxMs: 0,
logMessageTimestampType: "string",
logPreallocate: false,
logRetentionBytes: 0,
logRetentionHours: 0,
logRetentionMs: 0,
logRollJitterMs: 0,
logRollMs: 0,
logSegmentBytes: 0,
logSegmentDeleteDelayMs: 0,
maxConnectionsPerIp: 0,
maxIncrementalFetchSessionCacheSlots: 0,
messageMaxBytes: 0,
minInsyncReplicas: 0,
numPartitions: 0,
offsetsRetentionMinutes: 0,
producerPurgatoryPurgeIntervalRequests: 0,
replicaFetchMaxBytes: 0,
replicaFetchResponseMaxBytes: 0,
saslOauthbearerExpectedAudience: "string",
saslOauthbearerExpectedIssuer: "string",
saslOauthbearerJwksEndpointUrl: "string",
saslOauthbearerSubClaimName: "string",
socketRequestMaxBytes: 0,
transactionPartitionVerificationEnable: false,
transactionRemoveExpiredTransactionCleanupIntervalMs: 0,
transactionStateLogSegmentBytes: 0,
},
kafkaAuthenticationMethods: {
certificate: false,
sasl: false,
},
kafkaConnect: false,
kafkaConnectConfig: {
connectorClientConfigOverridePolicy: "string",
consumerAutoOffsetReset: "string",
consumerFetchMaxBytes: 0,
consumerIsolationLevel: "string",
consumerMaxPartitionFetchBytes: 0,
consumerMaxPollIntervalMs: 0,
consumerMaxPollRecords: 0,
offsetFlushIntervalMs: 0,
offsetFlushTimeoutMs: 0,
producerBatchSize: 0,
producerBufferMemory: 0,
producerCompressionType: "string",
producerLingerMs: 0,
producerMaxRequestSize: 0,
scheduledRebalanceMaxDelayMs: 0,
sessionTimeoutMs: 0,
},
kafkaConnectSecretProviders: [{
name: "string",
aws: {
authMethod: "string",
region: "string",
accessKey: "string",
secretKey: "string",
},
vault: {
address: "string",
authMethod: "string",
engineVersion: 0,
prefixPathDepth: 0,
token: "string",
},
}],
kafkaRest: false,
kafkaRestAuthorization: false,
kafkaRestConfig: {
consumerEnableAutoCommit: false,
consumerIdleDisconnectTimeout: 0,
consumerRequestMaxBytes: 0,
consumerRequestTimeoutMs: 0,
nameStrategy: "string",
nameStrategyValidation: false,
producerAcks: "string",
producerCompressionType: "string",
producerLingerMs: 0,
producerMaxRequestSize: 0,
simpleconsumerPoolSizeMax: 0,
},
kafkaSaslMechanisms: {
plain: false,
scramSha256: false,
scramSha512: false,
},
kafkaVersion: "string",
letsencryptSaslPrivatelink: false,
privateAccess: {
kafka: false,
kafkaConnect: false,
kafkaRest: false,
prometheus: false,
schemaRegistry: false,
},
privatelinkAccess: {
jolokia: false,
kafka: false,
kafkaConnect: false,
kafkaRest: false,
prometheus: false,
schemaRegistry: false,
},
publicAccess: {
kafka: false,
kafkaConnect: false,
kafkaRest: false,
prometheus: false,
schemaRegistry: false,
},
schemaRegistry: false,
schemaRegistryConfig: {
leaderEligibility: false,
retriableErrorsSilenced: false,
schemaReaderStrictMode: false,
topicName: "string",
},
serviceLog: false,
singleZone: {
enabled: false,
},
staticIps: false,
tieredStorage: {
enabled: false,
},
},
projectVpcId: "string",
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cloudName: "string",
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
techEmails: [{
email: "string",
}],
terminationProtection: false,
});
type: aiven:Kafka
properties:
additionalDiskSpace: string
cloudName: string
defaultAcl: false
kafkaUserConfig:
aivenKafkaTopicMessages: false
customDomain: string
followerFetching:
enabled: false
ipFilterObjects:
- description: string
network: string
ipFilterStrings:
- string
kafka:
autoCreateTopicsEnable: false
compressionType: string
connectionsMaxIdleMs: 0
defaultReplicationFactor: 0
groupInitialRebalanceDelayMs: 0
groupMaxSessionTimeoutMs: 0
groupMinSessionTimeoutMs: 0
logCleanerDeleteRetentionMs: 0
logCleanerMaxCompactionLagMs: 0
logCleanerMinCleanableRatio: 0
logCleanerMinCompactionLagMs: 0
logCleanupPolicy: string
logFlushIntervalMessages: 0
logFlushIntervalMs: 0
logIndexIntervalBytes: 0
logIndexSizeMaxBytes: 0
logLocalRetentionBytes: 0
logLocalRetentionMs: 0
logMessageDownconversionEnable: false
logMessageTimestampDifferenceMaxMs: 0
logMessageTimestampType: string
logPreallocate: false
logRetentionBytes: 0
logRetentionHours: 0
logRetentionMs: 0
logRollJitterMs: 0
logRollMs: 0
logSegmentBytes: 0
logSegmentDeleteDelayMs: 0
maxConnectionsPerIp: 0
maxIncrementalFetchSessionCacheSlots: 0
messageMaxBytes: 0
minInsyncReplicas: 0
numPartitions: 0
offsetsRetentionMinutes: 0
producerPurgatoryPurgeIntervalRequests: 0
replicaFetchMaxBytes: 0
replicaFetchResponseMaxBytes: 0
saslOauthbearerExpectedAudience: string
saslOauthbearerExpectedIssuer: string
saslOauthbearerJwksEndpointUrl: string
saslOauthbearerSubClaimName: string
socketRequestMaxBytes: 0
transactionPartitionVerificationEnable: false
transactionRemoveExpiredTransactionCleanupIntervalMs: 0
transactionStateLogSegmentBytes: 0
kafkaAuthenticationMethods:
certificate: false
sasl: false
kafkaConnect: false
kafkaConnectConfig:
connectorClientConfigOverridePolicy: string
consumerAutoOffsetReset: string
consumerFetchMaxBytes: 0
consumerIsolationLevel: string
consumerMaxPartitionFetchBytes: 0
consumerMaxPollIntervalMs: 0
consumerMaxPollRecords: 0
offsetFlushIntervalMs: 0
offsetFlushTimeoutMs: 0
producerBatchSize: 0
producerBufferMemory: 0
producerCompressionType: string
producerLingerMs: 0
producerMaxRequestSize: 0
scheduledRebalanceMaxDelayMs: 0
sessionTimeoutMs: 0
kafkaConnectSecretProviders:
- aws:
accessKey: string
authMethod: string
region: string
secretKey: string
name: string
vault:
address: string
authMethod: string
engineVersion: 0
prefixPathDepth: 0
token: string
kafkaRest: false
kafkaRestAuthorization: false
kafkaRestConfig:
consumerEnableAutoCommit: false
consumerIdleDisconnectTimeout: 0
consumerRequestMaxBytes: 0
consumerRequestTimeoutMs: 0
nameStrategy: string
nameStrategyValidation: false
producerAcks: string
producerCompressionType: string
producerLingerMs: 0
producerMaxRequestSize: 0
simpleconsumerPoolSizeMax: 0
kafkaSaslMechanisms:
plain: false
scramSha256: false
scramSha512: false
kafkaVersion: string
letsencryptSaslPrivatelink: false
privateAccess:
kafka: false
kafkaConnect: false
kafkaRest: false
prometheus: false
schemaRegistry: false
privatelinkAccess:
jolokia: false
kafka: false
kafkaConnect: false
kafkaRest: false
prometheus: false
schemaRegistry: false
publicAccess:
kafka: false
kafkaConnect: false
kafkaRest: false
prometheus: false
schemaRegistry: false
schemaRegistry: false
schemaRegistryConfig:
leaderEligibility: false
retriableErrorsSilenced: false
schemaReaderStrictMode: false
topicName: string
serviceLog: false
singleZone:
enabled: false
staticIps: false
tieredStorage:
enabled: false
kafkas:
- accessCert: string
accessKey: string
connectUri: string
restUri: string
schemaRegistryUri: string
uris:
- string
maintenanceWindowDow: string
maintenanceWindowTime: string
plan: string
project: string
projectVpcId: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
techEmails:
- email: 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:
- 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 seen from the Aiven pricing page. - Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- Cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - Default
Acl bool - Create a 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 List<KafkaKafka> - Kafka server connection details.
- Kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- 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.
- 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.
- Tech
Emails List<KafkaTech Email> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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.
- 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 seen from the Aiven pricing page. - Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- Cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - Default
Acl bool - Create a 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
User KafkaConfig Kafka User Config Args - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Kafkas
[]Kafka
Kafka Args - Kafka server connection details.
- 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.
- 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.
- Tech
Emails []KafkaTech Email Args - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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.
- 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 seen from the Aiven pricing page. - project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name String - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - default
Acl Boolean - Create a 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
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
List<Kafka
Kafka> - Kafka server connection details.
- 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.
- 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.
- tech
Emails List<KafkaTech Email> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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.
- 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 seen from the Aiven pricing page. - project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - default
Acl boolean - Create a 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
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
Kafka
Kafka[] - Kafka server connection details.
- 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.
- 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.
- tech
Emails KafkaTech Email[] - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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.
- 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 seen from the Aiven pricing page. - project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- service_
name str - 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud_
name str - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - default_
acl bool - Create a 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_
user_ Kafkaconfig Kafka User Config Args - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
Sequence[Kafka
Kafka Args] - Kafka server connection details.
- 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.
- 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.
- tech_
emails Sequence[KafkaTech Email Args] - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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.
- 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 seen from the Aiven pricing page. - project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name String - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - default
Acl Boolean - Create a 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
User Property MapConfig - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas List<Property Map>
- Kafka server connection details.
- 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.
- 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.
- tech
Emails List<Property Map> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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
- 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
- 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
- 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
- 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
- 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
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_user_config: Optional[KafkaKafkaUserConfigArgs] = None,
kafkas: Optional[Sequence[KafkaKafkaArgs]] = 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,
tech_emails: Optional[Sequence[KafkaTechEmailArgs]] = 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- Cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - Components
List<Kafka
Component> - Service component information objects
- Default
Acl bool - Create a 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 List<KafkaKafka> - Kafka server connection details.
- Kafka
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- 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 seen from the Aiven pricing page. - Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- Tech
Emails List<KafkaTech Email> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- Cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - Components
[]Kafka
Component Args - Service component information objects
- Default
Acl bool - Create a 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
User KafkaConfig Kafka User Config Args - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Kafkas
[]Kafka
Kafka Args - Kafka server connection details.
- 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 seen from the Aiven pricing page. - Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- Tech
Emails []KafkaTech Email Args - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name String - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - components
List<Kafka
Component> - Service component information objects
- default
Acl Boolean - Create a 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
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
List<Kafka
Kafka> - Kafka server connection details.
- 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 seen from the Aiven pricing page. - project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- tech
Emails List<KafkaTech Email> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name string - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - components
Kafka
Component[] - Service component information objects
- default
Acl boolean - Create a 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
User KafkaConfig Kafka User Config - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
Kafka
Kafka[] - Kafka server connection details.
- 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 seen from the Aiven pricing page. - project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- tech
Emails KafkaTech Email[] - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud_
name str - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - components
Sequence[Kafka
Component Args] - Service component information objects
- default_
acl bool - Create a 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_
user_ Kafkaconfig Kafka User Config Args - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas
Sequence[Kafka
Kafka Args] - Kafka server connection details.
- 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 seen from the Aiven pricing page. - project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- tech_
emails Sequence[KafkaTech Email Args] - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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 - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud
Name String - The cloud provider and region the service is hosted in. The format is
provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation. - components List<Property Map>
- Service component information objects
- default
Acl Boolean - Create a 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
User Property MapConfig - Kafka user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- kafkas List<Property Map>
- Kafka server connection details.
- 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 seen from the Aiven pricing page. - project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- 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
- 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.
- tech
Emails List<Property Map> - The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- 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
- Component string
- Service component name
- Connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_ca. - Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- Component string
- Service component name
- Connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- Host string
- Host name for connecting to the service component
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_ca. - Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- component String
- Service component name
- connection
Uri String - Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl StringCa - Kafka certificate used. The possible values are
letsencryptandproject_ca. - port Integer
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
- component string
- Service component name
- connection
Uri string - Connection info for connecting to the service component. This is a combination of host and port.
- host string
- Host name for connecting to the service component
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl stringCa - Kafka certificate used. The possible values are
letsencryptandproject_ca. - port number
- Port number for connecting to the service component
- route string
- Network access route
- ssl boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage string
- DNS usage name
- component str
- Service component name
- connection_
uri str - Connection info for connecting to the service component. This is a combination of host and port.
- host str
- Host name for connecting to the service component
- kafka_
authentication_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka_
ssl_ strca - Kafka certificate used. The possible values are
letsencryptandproject_ca. - port int
- Port number for connecting to the service component
- route str
- Network access route
- ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage str
- DNS usage name
- component String
- Service component name
- connection
Uri String - Connection info for connecting to the service component. This is a combination of host and port.
- host String
- Host name for connecting to the service component
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka
Ssl StringCa - Kafka certificate used. The possible values are
letsencryptandproject_ca. - port Number
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
KafkaKafka, KafkaKafkaArgs
- Access
Cert string - The Kafka client certificate.
- Access
Key string - The Kafka client certificate key.
- Connect
Uri string - The Kafka Connect URI.
- Rest
Uri string - The Kafka REST URI.
- Schema
Registry stringUri - The Schema Registry URI.
- Uris List<string>
- Kafka server URIs.
- Access
Cert string - The Kafka client certificate.
- Access
Key string - The Kafka client certificate key.
- Connect
Uri string - The Kafka Connect URI.
- Rest
Uri string - The Kafka REST URI.
- Schema
Registry stringUri - The Schema Registry URI.
- Uris []string
- Kafka server URIs.
- access
Cert String - The Kafka client certificate.
- access
Key String - The Kafka client certificate key.
- connect
Uri String - The Kafka Connect URI.
- rest
Uri String - The Kafka REST URI.
- schema
Registry StringUri - The Schema Registry URI.
- uris List<String>
- Kafka server URIs.
- access
Cert string - The Kafka client certificate.
- access
Key string - The Kafka client certificate key.
- connect
Uri string - The Kafka Connect URI.
- rest
Uri string - The Kafka REST URI.
- schema
Registry stringUri - The Schema Registry URI.
- uris string[]
- Kafka server URIs.
- access_
cert str - The Kafka client certificate.
- access_
key str - The Kafka client certificate key.
- connect_
uri str - The Kafka Connect URI.
- rest_
uri str - The Kafka REST URI.
- schema_
registry_ struri - The Schema Registry URI.
- uris Sequence[str]
- Kafka server URIs.
- access
Cert String - The Kafka client certificate.
- access
Key String - The Kafka client certificate key.
- connect
Uri String - The Kafka Connect URI.
- rest
Uri String - The Kafka REST URI.
- schema
Registry StringUri - The Schema Registry URI.
- uris List<String>
- Kafka server URIs.
KafkaKafkaUserConfig, KafkaKafkaUserConfigArgs
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Aiven
Kafka boolTopic Messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - Follower
Fetching KafkaKafka User Config Follower Fetching - Enable follower fetching
- 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
Filter List<string>Strings - 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 bool - Enable Kafka Connect service. Default:
false. - Kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- Kafka
Connect List<KafkaSecret Providers Kafka User Config Kafka Connect Secret Provider> - Kafka
Rest bool - Enable Kafka-REST service. Default:
false. - bool
- Enable authorization in Kafka-REST service.
- Kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- Kafka
Sasl KafkaMechanisms Kafka User Config Kafka Sasl Mechanisms - Kafka SASL mechanisms
- Kafka
Version string - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - Letsencrypt
Sasl boolPrivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 bool - Enable Schema-Registry service. Default:
false. - Schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Single
Zone KafkaKafka User Config Single Zone - Single-zone configuration
- Static
Ips bool - Use static public IP addresses.
- Tiered
Storage KafkaKafka User Config Tiered Storage - Tiered storage configuration
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Aiven
Kafka boolTopic Messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - Follower
Fetching KafkaKafka User Config Follower Fetching - Enable follower fetching
- Ip
Filter []KafkaObjects Kafka User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - Ip
Filter []stringStrings - 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 bool - Enable Kafka Connect service. Default:
false. - Kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- Kafka
Connect []KafkaSecret Providers Kafka User Config Kafka Connect Secret Provider - Kafka
Rest bool - Enable Kafka-REST service. Default:
false. - bool
- Enable authorization in Kafka-REST service.
- Kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- Kafka
Sasl KafkaMechanisms Kafka User Config Kafka Sasl Mechanisms - Kafka SASL mechanisms
- Kafka
Version string - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - Letsencrypt
Sasl boolPrivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 bool - Enable Schema-Registry service. Default:
false. - Schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Single
Zone KafkaKafka User Config Single Zone - Single-zone configuration
- Static
Ips bool - Use static public IP addresses.
- Tiered
Storage KafkaKafka User Config Tiered Storage - Tiered storage configuration
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- aiven
Kafka BooleanTopic Messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - follower
Fetching KafkaKafka User Config Follower Fetching - Enable follower fetching
- 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
Filter List<String>Strings - 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 Boolean - Enable Kafka Connect service. Default:
false. - kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka
Connect List<KafkaSecret Providers Kafka User Config Kafka Connect Secret Provider> - kafka
Rest Boolean - Enable Kafka-REST service. Default:
false. - Boolean
- Enable authorization in Kafka-REST service.
- kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka
Sasl KafkaMechanisms Kafka User Config Kafka Sasl Mechanisms - Kafka SASL mechanisms
- kafka
Version String - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - letsencrypt
Sasl BooleanPrivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 Boolean - Enable Schema-Registry service. Default:
false. - schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- single
Zone KafkaKafka User Config Single Zone - Single-zone configuration
- static
Ips Boolean - Use static public IP addresses.
- tiered
Storage KafkaKafka User Config Tiered Storage - Tiered storage configuration
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- aiven
Kafka booleanTopic Messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - follower
Fetching KafkaKafka User Config Follower Fetching - Enable follower fetching
- ip
Filter KafkaObjects Kafka User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip
Filter string[]Strings - 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 boolean - Enable Kafka Connect service. Default:
false. - kafka
Connect KafkaConfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka
Connect KafkaSecret Providers Kafka User Config Kafka Connect Secret Provider[] - kafka
Rest boolean - Enable Kafka-REST service. Default:
false. - boolean
- Enable authorization in Kafka-REST service.
- kafka
Rest KafkaConfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka
Sasl KafkaMechanisms Kafka User Config Kafka Sasl Mechanisms - Kafka SASL mechanisms
- kafka
Version string - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - letsencrypt
Sasl booleanPrivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 boolean - Enable Schema-Registry service. Default:
false. - schema
Registry KafkaConfig Kafka User Config Schema Registry Config - Schema Registry configuration
- service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- single
Zone KafkaKafka User Config Single Zone - Single-zone configuration
- static
Ips boolean - Use static public IP addresses.
- tiered
Storage KafkaKafka User Config Tiered Storage - Tiered storage configuration
- additional_
backup_ strregions - Additional Cloud Regions for Backup Replication.
- aiven_
kafka_ booltopic_ messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- custom_
domain str - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - follower_
fetching KafkaKafka User Config Follower Fetching - Enable follower fetching
- 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_
filter_ Sequence[str]strings - 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 bool - Enable Kafka Connect service. Default:
false. - kafka_
connect_ Kafkaconfig Kafka User Config Kafka Connect Config - Kafka Connect configuration values
- kafka_
connect_ Sequence[Kafkasecret_ providers Kafka User Config Kafka Connect Secret Provider] - kafka_
rest bool - Enable Kafka-REST service. Default:
false. - bool
- Enable authorization in Kafka-REST service.
- kafka_
rest_ Kafkaconfig Kafka User Config Kafka Rest Config - Kafka REST configuration
- kafka_
sasl_ Kafkamechanisms Kafka User Config Kafka Sasl Mechanisms - Kafka SASL mechanisms
- kafka_
version str - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - letsencrypt_
sasl_ boolprivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 bool - Enable Schema-Registry service. Default:
false. - schema_
registry_ Kafkaconfig Kafka User Config Schema Registry Config - Schema Registry configuration
- service_
log bool - Store logs for the service so that they are available in the HTTP API and console.
- single_
zone KafkaKafka User Config Single Zone - Single-zone configuration
- static_
ips bool - Use static public IP addresses.
- tiered_
storage KafkaKafka User Config Tiered Storage - Tiered storage configuration
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- aiven
Kafka BooleanTopic Messages - Allow access to read Kafka topic messages in the Aiven Console and REST API.
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org. - follower
Fetching Property Map - Enable follower fetching
- ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16 - ip
Filter List<String>Strings - 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 Boolean - Enable Kafka Connect service. Default:
false. - kafka
Connect Property MapConfig - Kafka Connect configuration values
- kafka
Connect List<Property Map>Secret Providers - kafka
Rest Boolean - Enable Kafka-REST service. Default:
false. - Boolean
- Enable authorization in Kafka-REST service.
- kafka
Rest Property MapConfig - Kafka REST configuration
- kafka
Sasl Property MapMechanisms - Kafka SASL mechanisms
- kafka
Version String - Enum:
3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9, and newer. Kafka major version. - letsencrypt
Sasl BooleanPrivatelink - Use Letsencrypt CA for Kafka SASL via Privatelink.
- 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 Boolean - Enable Schema-Registry service. Default:
false. - schema
Registry Property MapConfig - Schema Registry configuration
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- single
Zone Property Map - Single-zone configuration
- static
Ips Boolean - Use static public IP addresses.
- tiered
Storage Property Map - Tiered storage configuration
KafkaKafkaUserConfigFollowerFetching, KafkaKafkaUserConfigFollowerFetchingArgs
- Enabled bool
- Whether to enable the follower fetching functionality.
- Enabled bool
- Whether to enable the follower fetching functionality.
- enabled Boolean
- Whether to enable the follower fetching functionality.
- enabled boolean
- Whether to enable the follower fetching functionality.
- enabled bool
- Whether to enable the follower fetching functionality.
- enabled Boolean
- Whether to enable the follower fetching functionality.
KafkaKafkaUserConfigIpFilterObject, KafkaKafkaUserConfigIpFilterObjectArgs
- Network string
- CIDR address block. Example:
10.20.0.0/16. - Description string
- Description for IP filter list entry. Example:
Production service IP range.
- Network string
- CIDR address block. Example:
10.20.0.0/16. - Description string
- Description for IP filter list entry. Example:
Production service IP range.
- network String
- CIDR address block. Example:
10.20.0.0/16. - description String
- Description for IP filter list entry. Example:
Production service IP range.
- network string
- CIDR address block. Example:
10.20.0.0/16. - description string
- Description for IP filter list entry. Example:
Production service IP range.
- network str
- CIDR address block. Example:
10.20.0.0/16. - description str
- Description for IP filter list entry. Example:
Production service IP range.
- network String
- CIDR address block. Example:
10.20.0.0/16. - description String
- Description for IP filter list entry. Example:
Production service IP range.
KafkaKafkaUserConfigKafka, KafkaKafkaUserConfigKafkaArgs
- Auto
Create boolTopics Enable - Enable auto-creation of topics. (Default: true).
- Compression
Type string - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - Connections
Max intIdle Ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - Default
Replication intFactor - Replication factor for auto-created topics (Default: 3).
- Group
Initial intRebalance Delay Ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - Group
Max intSession Timeout Ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - Group
Min intSession Timeout Ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - Log
Cleaner intDelete Retention Ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - Log
Cleaner intMax Compaction Lag Ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- Log
Cleaner doubleMin Cleanable Ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - Log
Cleaner intMin Compaction Lag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- Log
Cleanup stringPolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - Log
Flush intInterval Messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- Log
Flush intInterval Ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- Log
Index intInterval Bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - Log
Index intSize Max Bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - Log
Local intRetention Bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- Log
Local intRetention Ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- Log
Message boolDownconversion Enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- Log
Message intTimestamp Difference Max Ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- Log
Message stringTimestamp Type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - Log
Preallocate bool - Should pre allocate file when create new segment? (Default: false).
- Log
Retention intBytes - The maximum size of the log before deleting messages (Default: -1).
- Log
Retention intHours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- Log
Retention intMs - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- Log
Roll intJitter Ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- Log
Roll intMs - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- Log
Segment intBytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- Log
Segment intDelete Delay Ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - Max
Connections intPer Ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- Max
Incremental intFetch Session Cache Slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - Message
Max intBytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - Min
Insync intReplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - Num
Partitions int - Number of partitions for auto-created topics (Default: 1).
- Offsets
Retention intMinutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - Producer
Purgatory intPurge Interval Requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- Replica
Fetch intMax Bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- Replica
Fetch intResponse Max Bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- Sasl
Oauthbearer stringExpected Audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- Sasl
Oauthbearer stringExpected Issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- Sasl
Oauthbearer stringJwks Endpoint Url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- Sasl
Oauthbearer stringSub Claim Name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- Socket
Request intMax Bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- Transaction
Partition boolVerification Enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- Transaction
Remove intExpired Transaction Cleanup Interval Ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - Transaction
State intLog Segment Bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
- Auto
Create boolTopics Enable - Enable auto-creation of topics. (Default: true).
- Compression
Type string - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - Connections
Max intIdle Ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - Default
Replication intFactor - Replication factor for auto-created topics (Default: 3).
- Group
Initial intRebalance Delay Ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - Group
Max intSession Timeout Ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - Group
Min intSession Timeout Ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - Log
Cleaner intDelete Retention Ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - Log
Cleaner intMax Compaction Lag Ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- Log
Cleaner float64Min Cleanable Ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - Log
Cleaner intMin Compaction Lag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- Log
Cleanup stringPolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - Log
Flush intInterval Messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- Log
Flush intInterval Ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- Log
Index intInterval Bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - Log
Index intSize Max Bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - Log
Local intRetention Bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- Log
Local intRetention Ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- Log
Message boolDownconversion Enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- Log
Message intTimestamp Difference Max Ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- Log
Message stringTimestamp Type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - Log
Preallocate bool - Should pre allocate file when create new segment? (Default: false).
- Log
Retention intBytes - The maximum size of the log before deleting messages (Default: -1).
- Log
Retention intHours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- Log
Retention intMs - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- Log
Roll intJitter Ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- Log
Roll intMs - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- Log
Segment intBytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- Log
Segment intDelete Delay Ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - Max
Connections intPer Ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- Max
Incremental intFetch Session Cache Slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - Message
Max intBytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - Min
Insync intReplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - Num
Partitions int - Number of partitions for auto-created topics (Default: 1).
- Offsets
Retention intMinutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - Producer
Purgatory intPurge Interval Requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- Replica
Fetch intMax Bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- Replica
Fetch intResponse Max Bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- Sasl
Oauthbearer stringExpected Audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- Sasl
Oauthbearer stringExpected Issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- Sasl
Oauthbearer stringJwks Endpoint Url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- Sasl
Oauthbearer stringSub Claim Name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- Socket
Request intMax Bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- Transaction
Partition boolVerification Enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- Transaction
Remove intExpired Transaction Cleanup Interval Ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - Transaction
State intLog Segment Bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
- auto
Create BooleanTopics Enable - Enable auto-creation of topics. (Default: true).
- compression
Type String - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - connections
Max IntegerIdle Ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - default
Replication IntegerFactor - Replication factor for auto-created topics (Default: 3).
- group
Initial IntegerRebalance Delay Ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - group
Max IntegerSession Timeout Ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - group
Min IntegerSession Timeout Ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - log
Cleaner IntegerDelete Retention Ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - log
Cleaner IntegerMax Compaction Lag Ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- log
Cleaner DoubleMin Cleanable Ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - log
Cleaner IntegerMin Compaction Lag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- log
Cleanup StringPolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - log
Flush IntegerInterval Messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Flush IntegerInterval Ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- log
Index IntegerInterval Bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - log
Index IntegerSize Max Bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - log
Local IntegerRetention Bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- log
Local IntegerRetention Ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- log
Message BooleanDownconversion Enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- log
Message IntegerTimestamp Difference Max Ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Message StringTimestamp Type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - log
Preallocate Boolean - Should pre allocate file when create new segment? (Default: false).
- log
Retention IntegerBytes - The maximum size of the log before deleting messages (Default: -1).
- log
Retention IntegerHours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- log
Retention IntegerMs - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- log
Roll IntegerJitter Ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- log
Roll IntegerMs - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- log
Segment IntegerBytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- log
Segment IntegerDelete Delay Ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - max
Connections IntegerPer Ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- max
Incremental IntegerFetch Session Cache Slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - message
Max IntegerBytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - min
Insync IntegerReplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - num
Partitions Integer - Number of partitions for auto-created topics (Default: 1).
- offsets
Retention IntegerMinutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - producer
Purgatory IntegerPurge Interval Requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- replica
Fetch IntegerMax Bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- replica
Fetch IntegerResponse Max Bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- sasl
Oauthbearer StringExpected Audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- sasl
Oauthbearer StringExpected Issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- sasl
Oauthbearer StringJwks Endpoint Url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- sasl
Oauthbearer StringSub Claim Name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- socket
Request IntegerMax Bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- transaction
Partition BooleanVerification Enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- transaction
Remove IntegerExpired Transaction Cleanup Interval Ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - transaction
State IntegerLog Segment Bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
- auto
Create booleanTopics Enable - Enable auto-creation of topics. (Default: true).
- compression
Type string - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - connections
Max numberIdle Ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - default
Replication numberFactor - Replication factor for auto-created topics (Default: 3).
- group
Initial numberRebalance Delay Ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - group
Max numberSession Timeout Ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - group
Min numberSession Timeout Ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - log
Cleaner numberDelete Retention Ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - log
Cleaner numberMax Compaction Lag Ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- log
Cleaner numberMin Cleanable Ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - log
Cleaner numberMin Compaction Lag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- log
Cleanup stringPolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - log
Flush numberInterval Messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Flush numberInterval Ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- log
Index numberInterval Bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - log
Index numberSize Max Bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - log
Local numberRetention Bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- log
Local numberRetention Ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- log
Message booleanDownconversion Enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- log
Message numberTimestamp Difference Max Ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Message stringTimestamp Type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - log
Preallocate boolean - Should pre allocate file when create new segment? (Default: false).
- log
Retention numberBytes - The maximum size of the log before deleting messages (Default: -1).
- log
Retention numberHours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- log
Retention numberMs - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- log
Roll numberJitter Ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- log
Roll numberMs - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- log
Segment numberBytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- log
Segment numberDelete Delay Ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - max
Connections numberPer Ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- max
Incremental numberFetch Session Cache Slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - message
Max numberBytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - min
Insync numberReplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - num
Partitions number - Number of partitions for auto-created topics (Default: 1).
- offsets
Retention numberMinutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - producer
Purgatory numberPurge Interval Requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- replica
Fetch numberMax Bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- replica
Fetch numberResponse Max Bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- sasl
Oauthbearer stringExpected Audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- sasl
Oauthbearer stringExpected Issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- sasl
Oauthbearer stringJwks Endpoint Url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- sasl
Oauthbearer stringSub Claim Name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- socket
Request numberMax Bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- transaction
Partition booleanVerification Enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- transaction
Remove numberExpired Transaction Cleanup Interval Ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - transaction
State numberLog Segment Bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
- auto_
create_ booltopics_ enable - Enable auto-creation of topics. (Default: true).
- compression_
type str - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - connections_
max_ intidle_ ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - default_
replication_ intfactor - Replication factor for auto-created topics (Default: 3).
- group_
initial_ intrebalance_ delay_ ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - group_
max_ intsession_ timeout_ ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - group_
min_ intsession_ timeout_ ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - log_
cleaner_ intdelete_ retention_ ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - log_
cleaner_ intmax_ compaction_ lag_ ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- log_
cleaner_ floatmin_ cleanable_ ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - log_
cleaner_ intmin_ compaction_ lag_ ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- log_
cleanup_ strpolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - log_
flush_ intinterval_ messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log_
flush_ intinterval_ ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- log_
index_ intinterval_ bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - log_
index_ intsize_ max_ bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - log_
local_ intretention_ bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- log_
local_ intretention_ ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- log_
message_ booldownconversion_ enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- log_
message_ inttimestamp_ difference_ max_ ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log_
message_ strtimestamp_ type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - log_
preallocate bool - Should pre allocate file when create new segment? (Default: false).
- log_
retention_ intbytes - The maximum size of the log before deleting messages (Default: -1).
- log_
retention_ inthours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- log_
retention_ intms - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- log_
roll_ intjitter_ ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- log_
roll_ intms - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- log_
segment_ intbytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- log_
segment_ intdelete_ delay_ ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - max_
connections_ intper_ ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- max_
incremental_ intfetch_ session_ cache_ slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - message_
max_ intbytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - min_
insync_ intreplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - num_
partitions int - Number of partitions for auto-created topics (Default: 1).
- offsets_
retention_ intminutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - producer_
purgatory_ intpurge_ interval_ requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- replica_
fetch_ intmax_ bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- replica_
fetch_ intresponse_ max_ bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- sasl_
oauthbearer_ strexpected_ audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- sasl_
oauthbearer_ strexpected_ issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- sasl_
oauthbearer_ strjwks_ endpoint_ url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- sasl_
oauthbearer_ strsub_ claim_ name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- socket_
request_ intmax_ bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- transaction_
partition_ boolverification_ enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- transaction_
remove_ intexpired_ transaction_ cleanup_ interval_ ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - transaction_
state_ intlog_ segment_ bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
- auto
Create BooleanTopics Enable - Enable auto-creation of topics. (Default: true).
- compression
Type String - Enum:
gzip,lz4,producer,snappy,uncompressed,zstd. Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsuncompressedwhich is equivalent to no compression; andproducerwhich means retain the original compression codec set by the producer.(Default: producer). - connections
Max NumberIdle Ms - Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes)). Example:
540000. - default
Replication NumberFactor - Replication factor for auto-created topics (Default: 3).
- group
Initial NumberRebalance Delay Ms - The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds)). Example:
3000. - group
Max NumberSession Timeout Ms - The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes). Example:
1800000. - group
Min NumberSession Timeout Ms - The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds)). Example:
6000. - log
Cleaner NumberDelete Retention Ms - How long are delete records retained? (Default: 86400000 (1 day)). Example:
86400000. - log
Cleaner NumberMax Compaction Lag Ms - The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE)).
- log
Cleaner NumberMin Cleanable Ratio - Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5). Example:
0.5. - log
Cleaner NumberMin Compaction Lag Ms - The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms).
- log
Cleanup StringPolicy - Enum:
compact,compact,delete,delete. The default cleanup policy for segments beyond the retention window (Default: delete). - log
Flush NumberInterval Messages - The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Flush NumberInterval Ms - The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null).
- log
Index NumberInterval Bytes - The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes)). Example:
4096. - log
Index NumberSize Max Bytes - The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes)). Example:
10485760. - log
Local NumberRetention Bytes - The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. (Default: -2).
- log
Local NumberRetention Ms - The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. (Default: -2).
- log
Message BooleanDownconversion Enable - This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true).
- log
Message NumberTimestamp Difference Max Ms - The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE)).
- log
Message StringTimestamp Type - Enum:
CreateTime,LogAppendTime. Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime). - log
Preallocate Boolean - Should pre allocate file when create new segment? (Default: false).
- log
Retention NumberBytes - The maximum size of the log before deleting messages (Default: -1).
- log
Retention NumberHours - The number of hours to keep a log file before deleting it (Default: 168 hours (1 week)).
- log
Retention NumberMs - The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies).
- log
Roll NumberJitter Ms - The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null).
- log
Roll NumberMs - The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days)).
- log
Segment NumberBytes - The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte)).
- log
Segment NumberDelete Delay Ms - The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute)). Example:
60000. - max
Connections NumberPer Ip - The maximum number of connections allowed from each ip address (Default: 2147483647).
- max
Incremental NumberFetch Session Cache Slots - The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000). Example:
1000. - message
Max NumberBytes - The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes)). Example:
1048588. - min
Insync NumberReplicas - When a producer sets acks to
all(or-1), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1). Example:1. - num
Partitions Number - Number of partitions for auto-created topics (Default: 1).
- offsets
Retention NumberMinutes - Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days)). Example:
10080. - producer
Purgatory NumberPurge Interval Requests - The purge interval (in number of requests) of the producer request purgatory (Default: 1000).
- replica
Fetch NumberMax Bytes - The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes)).
- replica
Fetch NumberResponse Max Bytes - Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes)).
- sasl
Oauthbearer StringExpected Audience - The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null).
- sasl
Oauthbearer StringExpected Issuer - Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null).
- sasl
Oauthbearer StringJwks Endpoint Url - OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null).
- sasl
Oauthbearer StringSub Claim Name - Name of the scope from which to extract the subject claim from the JWT.(Default: sub).
- socket
Request NumberMax Bytes - The maximum number of bytes in a socket request (Default: 104857600 bytes).
- transaction
Partition BooleanVerification Enable - Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: true).
- transaction
Remove NumberExpired Transaction Cleanup Interval Ms - The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)). Example:
3600000. - transaction
State NumberLog Segment Bytes - The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)). Example:
104857600.
KafkaKafkaUserConfigKafkaAuthenticationMethods, KafkaKafkaUserConfigKafkaAuthenticationMethodsArgs
- Certificate bool
- Enable certificate/SSL authentication. Default:
true. - Sasl bool
- Enable SASL authentication. Default:
false.
- Certificate bool
- Enable certificate/SSL authentication. Default:
true. - Sasl bool
- Enable SASL authentication. Default:
false.
- certificate Boolean
- Enable certificate/SSL authentication. Default:
true. - sasl Boolean
- Enable SASL authentication. Default:
false.
- certificate boolean
- Enable certificate/SSL authentication. Default:
true. - sasl boolean
- Enable SASL authentication. Default:
false.
- certificate bool
- Enable certificate/SSL authentication. Default:
true. - sasl bool
- Enable SASL authentication. Default:
false.
- certificate Boolean
- Enable certificate/SSL authentication. Default:
true. - sasl Boolean
- Enable SASL authentication. Default:
false.
KafkaKafkaUserConfigKafkaConnectConfig, KafkaKafkaUserConfigKafkaConnectConfigArgs
- Connector
Client stringConfig Override Policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - Consumer
Auto stringOffset Reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - Consumer
Fetch intMax Bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - Consumer
Isolation stringLevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - Consumer
Max intPartition Fetch Bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - Consumer
Max intPoll Interval Ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- Consumer
Max intPoll Records - The maximum number of records returned in a single call to poll() (defaults to 500).
- Offset
Flush intInterval Ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- Offset
Flush intTimeout Ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- Producer
Batch intSize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - Producer
Buffer intMemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- Producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - Producer
Linger intMs - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - Producer
Max intRequest Size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - Scheduled
Rebalance intMax Delay Ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- Session
Timeout intMs - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- Connector
Client stringConfig Override Policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - Consumer
Auto stringOffset Reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - Consumer
Fetch intMax Bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - Consumer
Isolation stringLevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - Consumer
Max intPartition Fetch Bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - Consumer
Max intPoll Interval Ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- Consumer
Max intPoll Records - The maximum number of records returned in a single call to poll() (defaults to 500).
- Offset
Flush intInterval Ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- Offset
Flush intTimeout Ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- Producer
Batch intSize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - Producer
Buffer intMemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- Producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - Producer
Linger intMs - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - Producer
Max intRequest Size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - Scheduled
Rebalance intMax Delay Ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- Session
Timeout intMs - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connector
Client StringConfig Override Policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - consumer
Auto StringOffset Reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - consumer
Fetch IntegerMax Bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - consumer
Isolation StringLevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - consumer
Max IntegerPartition Fetch Bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - consumer
Max IntegerPoll Interval Ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumer
Max IntegerPoll Records - The maximum number of records returned in a single call to poll() (defaults to 500).
- offset
Flush IntegerInterval Ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- offset
Flush IntegerTimeout Ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producer
Batch IntegerSize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - producer
Buffer IntegerMemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producer
Compression StringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger IntegerMs - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - producer
Max IntegerRequest Size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - scheduled
Rebalance IntegerMax Delay Ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- session
Timeout IntegerMs - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connector
Client stringConfig Override Policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - consumer
Auto stringOffset Reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - consumer
Fetch numberMax Bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - consumer
Isolation stringLevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - consumer
Max numberPartition Fetch Bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - consumer
Max numberPoll Interval Ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumer
Max numberPoll Records - The maximum number of records returned in a single call to poll() (defaults to 500).
- offset
Flush numberInterval Ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- offset
Flush numberTimeout Ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producer
Batch numberSize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - producer
Buffer numberMemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger numberMs - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - producer
Max numberRequest Size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - scheduled
Rebalance numberMax Delay Ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- session
Timeout numberMs - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connector_
client_ strconfig_ override_ policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - consumer_
auto_ stroffset_ reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - consumer_
fetch_ intmax_ bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - consumer_
isolation_ strlevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - consumer_
max_ intpartition_ fetch_ bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - consumer_
max_ intpoll_ interval_ ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumer_
max_ intpoll_ records - The maximum number of records returned in a single call to poll() (defaults to 500).
- offset_
flush_ intinterval_ ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- offset_
flush_ inttimeout_ ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producer_
batch_ intsize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - producer_
buffer_ intmemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producer_
compression_ strtype - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer_
linger_ intms - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - producer_
max_ intrequest_ size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - scheduled_
rebalance_ intmax_ delay_ ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- session_
timeout_ intms - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connector
Client StringConfig Override Policy - Enum:
All,None. Defines what client configurations can be overridden by the connector. Default is None. - consumer
Auto StringOffset Reset - Enum:
earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest. - consumer
Fetch NumberMax Bytes - Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example:
52428800. - consumer
Isolation StringLevel - Enum:
read_committed,read_uncommitted. Transaction read isolation level. readuncommitted is the default, but readcommitted can be used if consume-exactly-once behavior is desired. - consumer
Max NumberPartition Fetch Bytes - Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example:
1048576. - consumer
Max NumberPoll Interval Ms - The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumer
Max NumberPoll Records - The maximum number of records returned in a single call to poll() (defaults to 500).
- offset
Flush NumberInterval Ms - The interval at which to try committing offsets for tasks (defaults to 60000).
- offset
Flush NumberTimeout Ms - Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producer
Batch NumberSize - This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will
lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - producer
Buffer NumberMemory - The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producer
Compression StringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger NumberMs - This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will
lingerfor the specified time waiting for more records to show up. Defaults to 0. - producer
Max NumberRequest Size - This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example:
1048576. - scheduled
Rebalance NumberMax Delay Ms - The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- session
Timeout NumberMs - The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
KafkaKafkaUserConfigKafkaConnectSecretProvider, KafkaKafkaUserConfigKafkaConnectSecretProviderArgs
- Name string
- Name of the secret provider. Used to reference secrets in connector config.
- Aws
Kafka
Kafka User Config Kafka Connect Secret Provider Aws - AWS secret provider configuration
- Vault
Kafka
Kafka User Config Kafka Connect Secret Provider Vault - Vault secret provider configuration
- Name string
- Name of the secret provider. Used to reference secrets in connector config.
- Aws
Kafka
Kafka User Config Kafka Connect Secret Provider Aws - AWS secret provider configuration
- Vault
Kafka
Kafka User Config Kafka Connect Secret Provider Vault - Vault secret provider configuration
- name String
- Name of the secret provider. Used to reference secrets in connector config.
- aws
Kafka
Kafka User Config Kafka Connect Secret Provider Aws - AWS secret provider configuration
- vault
Kafka
Kafka User Config Kafka Connect Secret Provider Vault - Vault secret provider configuration
- name string
- Name of the secret provider. Used to reference secrets in connector config.
- aws
Kafka
Kafka User Config Kafka Connect Secret Provider Aws - AWS secret provider configuration
- vault
Kafka
Kafka User Config Kafka Connect Secret Provider Vault - Vault secret provider configuration
- name str
- Name of the secret provider. Used to reference secrets in connector config.
- aws
Kafka
Kafka User Config Kafka Connect Secret Provider Aws - AWS secret provider configuration
- vault
Kafka
Kafka User Config Kafka Connect Secret Provider Vault - Vault secret provider configuration
- name String
- Name of the secret provider. Used to reference secrets in connector config.
- aws Property Map
- AWS secret provider configuration
- vault Property Map
- Vault secret provider configuration
KafkaKafkaUserConfigKafkaConnectSecretProviderAws, KafkaKafkaUserConfigKafkaConnectSecretProviderAwsArgs
- Auth
Method string - Enum:
credentials. Auth method of the vault secret provider. - Region string
- Region used to lookup secrets with AWS SecretManager.
- Access
Key string - Access key used to authenticate with aws.
- Secret
Key string - Secret key used to authenticate with aws.
- Auth
Method string - Enum:
credentials. Auth method of the vault secret provider. - Region string
- Region used to lookup secrets with AWS SecretManager.
- Access
Key string - Access key used to authenticate with aws.
- Secret
Key string - Secret key used to authenticate with aws.
- auth
Method String - Enum:
credentials. Auth method of the vault secret provider. - region String
- Region used to lookup secrets with AWS SecretManager.
- access
Key String - Access key used to authenticate with aws.
- secret
Key String - Secret key used to authenticate with aws.
- auth
Method string - Enum:
credentials. Auth method of the vault secret provider. - region string
- Region used to lookup secrets with AWS SecretManager.
- access
Key string - Access key used to authenticate with aws.
- secret
Key string - Secret key used to authenticate with aws.
- auth_
method str - Enum:
credentials. Auth method of the vault secret provider. - region str
- Region used to lookup secrets with AWS SecretManager.
- access_
key str - Access key used to authenticate with aws.
- secret_
key str - Secret key used to authenticate with aws.
- auth
Method String - Enum:
credentials. Auth method of the vault secret provider. - region String
- Region used to lookup secrets with AWS SecretManager.
- access
Key String - Access key used to authenticate with aws.
- secret
Key String - Secret key used to authenticate with aws.
KafkaKafkaUserConfigKafkaConnectSecretProviderVault, KafkaKafkaUserConfigKafkaConnectSecretProviderVaultArgs
- Address string
- Address of the Vault server.
- Auth
Method string - Enum:
token. Auth method of the vault secret provider. - Engine
Version int - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - Prefix
Path intDepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- Token string
- Token used to authenticate with vault and auth method
token.
- Address string
- Address of the Vault server.
- Auth
Method string - Enum:
token. Auth method of the vault secret provider. - Engine
Version int - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - Prefix
Path intDepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- Token string
- Token used to authenticate with vault and auth method
token.
- address String
- Address of the Vault server.
- auth
Method String - Enum:
token. Auth method of the vault secret provider. - engine
Version Integer - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - prefix
Path IntegerDepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token String
- Token used to authenticate with vault and auth method
token.
- address string
- Address of the Vault server.
- auth
Method string - Enum:
token. Auth method of the vault secret provider. - engine
Version number - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - prefix
Path numberDepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token string
- Token used to authenticate with vault and auth method
token.
- address str
- Address of the Vault server.
- auth_
method str - Enum:
token. Auth method of the vault secret provider. - engine_
version int - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - prefix_
path_ intdepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token str
- Token used to authenticate with vault and auth method
token.
- address String
- Address of the Vault server.
- auth
Method String - Enum:
token. Auth method of the vault secret provider. - engine
Version Number - Enum:
1,2, and newer. KV Secrets Engine version of the Vault server instance. - prefix
Path NumberDepth - Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token String
- Token used to authenticate with vault and auth method
token.
KafkaKafkaUserConfigKafkaRestConfig, KafkaKafkaUserConfigKafkaRestConfigArgs
- Consumer
Enable boolAuto Commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - Consumer
Idle intDisconnect Timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - Consumer
Request intMax Bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - Consumer
Request intTimeout Ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - Name
Strategy string - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - Name
Strategy boolValidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - Producer
Acks string - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - Producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - Producer
Linger intMs - Wait for up to the given delay to allow batching records together. Default:
0. - Producer
Max intRequest Size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - Simpleconsumer
Pool intSize Max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
- Consumer
Enable boolAuto Commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - Consumer
Idle intDisconnect Timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - Consumer
Request intMax Bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - Consumer
Request intTimeout Ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - Name
Strategy string - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - Name
Strategy boolValidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - Producer
Acks string - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - Producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - Producer
Linger intMs - Wait for up to the given delay to allow batching records together. Default:
0. - Producer
Max intRequest Size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - Simpleconsumer
Pool intSize Max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
- consumer
Enable BooleanAuto Commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - consumer
Idle IntegerDisconnect Timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - consumer
Request IntegerMax Bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - consumer
Request IntegerTimeout Ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - name
Strategy String - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - name
Strategy BooleanValidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - producer
Acks String - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - producer
Compression StringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger IntegerMs - Wait for up to the given delay to allow batching records together. Default:
0. - producer
Max IntegerRequest Size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - simpleconsumer
Pool IntegerSize Max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
- consumer
Enable booleanAuto Commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - consumer
Idle numberDisconnect Timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - consumer
Request numberMax Bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - consumer
Request numberTimeout Ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - name
Strategy string - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - name
Strategy booleanValidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - producer
Acks string - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - producer
Compression stringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger numberMs - Wait for up to the given delay to allow batching records together. Default:
0. - producer
Max numberRequest Size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - simpleconsumer
Pool numberSize Max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
- consumer_
enable_ boolauto_ commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - consumer_
idle_ intdisconnect_ timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - consumer_
request_ intmax_ bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - consumer_
request_ inttimeout_ ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - name_
strategy str - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - name_
strategy_ boolvalidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - producer_
acks str - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - producer_
compression_ strtype - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer_
linger_ intms - Wait for up to the given delay to allow batching records together. Default:
0. - producer_
max_ intrequest_ size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - simpleconsumer_
pool_ intsize_ max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
- consumer
Enable BooleanAuto Commit - If true the consumer's offset will be periodically committed to Kafka in the background. Default:
true. - consumer
Idle NumberDisconnect Timeout - Specifies the maximum duration (in seconds) a client can remain idle before it is deleted. If a consumer is inactive, it will exit the consumer group, and its state will be discarded. A value of 0 (default) indicates that the consumer will not be disconnected automatically due to inactivity. Default:
0. - consumer
Request NumberMax Bytes - Maximum number of bytes in unencoded message keys and values by a single request. Default:
67108864. - consumer
Request NumberTimeout Ms - Enum:
1000,15000,30000. The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. Default:1000. - name
Strategy String - Enum:
record_name,topic_name,topic_record_name. Name strategy to use when selecting subject for storing schemas. Default:topic_name. - name
Strategy BooleanValidation - If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. Default:
true. - producer
Acks String - Enum:
-1,0,1,all. The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set toallor-1, the leader will wait for the full set of in-sync replicas to acknowledge the record. Default:1. - producer
Compression StringType - Enum:
gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression. - producer
Linger NumberMs - Wait for up to the given delay to allow batching records together. Default:
0. - producer
Max NumberRequest Size - The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. Default:
1048576. - simpleconsumer
Pool NumberSize Max - Maximum number of SimpleConsumers that can be instantiated per broker. Default:
25.
KafkaKafkaUserConfigKafkaSaslMechanisms, KafkaKafkaUserConfigKafkaSaslMechanismsArgs
- Plain bool
- Enable PLAIN mechanism. Default:
true. - Scram
Sha256 bool - Enable SCRAM-SHA-256 mechanism. Default:
true. - Scram
Sha512 bool - Enable SCRAM-SHA-512 mechanism. Default:
true.
- Plain bool
- Enable PLAIN mechanism. Default:
true. - Scram
Sha256 bool - Enable SCRAM-SHA-256 mechanism. Default:
true. - Scram
Sha512 bool - Enable SCRAM-SHA-512 mechanism. Default:
true.
- plain Boolean
- Enable PLAIN mechanism. Default:
true. - scram
Sha256 Boolean - Enable SCRAM-SHA-256 mechanism. Default:
true. - scram
Sha512 Boolean - Enable SCRAM-SHA-512 mechanism. Default:
true.
- plain boolean
- Enable PLAIN mechanism. Default:
true. - scram
Sha256 boolean - Enable SCRAM-SHA-256 mechanism. Default:
true. - scram
Sha512 boolean - Enable SCRAM-SHA-512 mechanism. Default:
true.
- plain bool
- Enable PLAIN mechanism. Default:
true. - scram_
sha256 bool - Enable SCRAM-SHA-256 mechanism. Default:
true. - scram_
sha512 bool - Enable SCRAM-SHA-512 mechanism. Default:
true.
- plain Boolean
- Enable PLAIN mechanism. Default:
true. - scram
Sha256 Boolean - Enable SCRAM-SHA-256 mechanism. Default:
true. - scram
Sha512 Boolean - Enable SCRAM-SHA-512 mechanism. Default:
true.
KafkaKafkaUserConfigPrivateAccess, KafkaKafkaUserConfigPrivateAccessArgs
- Kafka bool
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Kafka
Connect bool - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Kafka
Rest bool - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Schema
Registry bool - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Kafka bool
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Kafka
Connect bool - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Kafka
Rest bool - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- Schema
Registry bool - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka Boolean
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Connect Boolean - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Rest Boolean - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus Boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- schema
Registry Boolean - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka boolean
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Connect boolean - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Rest boolean - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- schema
Registry boolean - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka bool
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka_
connect bool - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka_
rest bool - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus bool
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- schema_
registry bool - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka Boolean
- Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Connect Boolean - Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- kafka
Rest Boolean - Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- prometheus Boolean
- Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
- schema
Registry Boolean - Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
KafkaKafkaUserConfigPrivatelinkAccess, KafkaKafkaUserConfigPrivatelinkAccessArgs
- Jolokia bool
- Enable jolokia.
- Kafka bool
- Enable kafka.
- Kafka
Connect bool - Enable kafka_connect.
- Kafka
Rest bool - Enable kafka_rest.
- Prometheus bool
- Enable prometheus.
- Schema
Registry bool - Enable schema_registry.
- Jolokia bool
- Enable jolokia.
- Kafka bool
- Enable kafka.
- Kafka
Connect bool - Enable kafka_connect.
- Kafka
Rest bool - Enable kafka_rest.
- Prometheus bool
- Enable prometheus.
- Schema
Registry bool - Enable schema_registry.
- jolokia Boolean
- Enable jolokia.
- kafka Boolean
- Enable kafka.
- kafka
Connect Boolean - Enable kafka_connect.
- kafka
Rest Boolean - Enable kafka_rest.
- prometheus Boolean
- Enable prometheus.
- schema
Registry Boolean - Enable schema_registry.
- jolokia boolean
- Enable jolokia.
- kafka boolean
- Enable kafka.
- kafka
Connect boolean - Enable kafka_connect.
- kafka
Rest boolean - Enable kafka_rest.
- prometheus boolean
- Enable prometheus.
- schema
Registry boolean - Enable schema_registry.
- jolokia bool
- Enable jolokia.
- kafka bool
- Enable kafka.
- kafka_
connect bool - Enable kafka_connect.
- kafka_
rest bool - Enable kafka_rest.
- prometheus bool
- Enable prometheus.
- schema_
registry bool - Enable schema_registry.
- jolokia Boolean
- Enable jolokia.
- kafka Boolean
- Enable kafka.
- kafka
Connect Boolean - Enable kafka_connect.
- kafka
Rest Boolean - Enable kafka_rest.
- prometheus Boolean
- Enable prometheus.
- schema
Registry Boolean - Enable schema_registry.
KafkaKafkaUserConfigPublicAccess, KafkaKafkaUserConfigPublicAccessArgs
- Kafka bool
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- Kafka
Connect bool - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- Kafka
Rest bool - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- Prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- Schema
Registry bool - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
- Kafka bool
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- Kafka
Connect bool - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- Kafka
Rest bool - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- Prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- Schema
Registry bool - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka Boolean
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Connect Boolean - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Rest Boolean - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus Boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- schema
Registry Boolean - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka boolean
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Connect boolean - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Rest boolean - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- schema
Registry boolean - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka bool
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka_
connect bool - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka_
rest bool - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus bool
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- schema_
registry bool - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka Boolean
- Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Connect Boolean - Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
- kafka
Rest Boolean - Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network.
- prometheus Boolean
- Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
- schema
Registry Boolean - Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network.
KafkaKafkaUserConfigSchemaRegistryConfig, KafkaKafkaUserConfigSchemaRegistryConfigArgs
- Leader
Eligibility bool - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - Retriable
Errors boolSilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - Schema
Reader boolStrict Mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - Topic
Name string - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
- Leader
Eligibility bool - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - Retriable
Errors boolSilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - Schema
Reader boolStrict Mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - Topic
Name string - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
- leader
Eligibility Boolean - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - retriable
Errors BooleanSilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - schema
Reader BooleanStrict Mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - topic
Name String - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
- leader
Eligibility boolean - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - retriable
Errors booleanSilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - schema
Reader booleanStrict Mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - topic
Name string - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
- leader_
eligibility bool - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - retriable_
errors_ boolsilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - schema_
reader_ boolstrict_ mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - topic_
name str - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
- leader
Eligibility Boolean - If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to
true. - retriable
Errors BooleanSilenced - If enabled, kafka errors which can be retried or custom errors specified for the service will not be raised, instead, a warning log is emitted. This will denoise issue tracking systems, i.e. sentry. Defaults to
true. - schema
Reader BooleanStrict Mode - If enabled, causes the Karapace schema-registry service to shutdown when there are invalid schema records in the
_schemastopic. Defaults tofalse. - topic
Name String - The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to
_schemas.
KafkaKafkaUserConfigSingleZone, KafkaKafkaUserConfigSingleZoneArgs
- Enabled bool
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
- Enabled bool
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
- enabled Boolean
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
- enabled boolean
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
- enabled bool
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
- enabled Boolean
- Whether to allocate nodes on the same Availability Zone or spread across zones available. By default service nodes are spread across different AZs. The single AZ support is best-effort and may temporarily allocate nodes in different AZs e.g. in case of capacity limitations in one AZ.
KafkaKafkaUserConfigTieredStorage, KafkaKafkaUserConfigTieredStorageArgs
- Enabled bool
- Whether to enable the tiered storage functionality.
- Local
Cache KafkaKafka User Config Tiered Storage Local Cache - Local cache configuration
- Enabled bool
- Whether to enable the tiered storage functionality.
- Local
Cache KafkaKafka User Config Tiered Storage Local Cache - Local cache configuration
- enabled Boolean
- Whether to enable the tiered storage functionality.
- local
Cache KafkaKafka User Config Tiered Storage Local Cache - Local cache configuration
- enabled boolean
- Whether to enable the tiered storage functionality.
- local
Cache KafkaKafka User Config Tiered Storage Local Cache - Local cache configuration
- enabled bool
- Whether to enable the tiered storage functionality.
- local_
cache KafkaKafka User Config Tiered Storage Local Cache - Local cache configuration
- enabled Boolean
- Whether to enable the tiered storage functionality.
- local
Cache Property Map - Local cache configuration
KafkaKafkaUserConfigTieredStorageLocalCache, KafkaKafkaUserConfigTieredStorageLocalCacheArgs
- Size int
- Local cache size in bytes. Example:
1073741824.
- Size int
- Local cache size in bytes. Example:
1073741824.
- size Integer
- Local cache size in bytes. Example:
1073741824.
- size number
- Local cache size in bytes. Example:
1073741824.
- size int
- Local cache size in bytes. Example:
1073741824.
- size Number
- Local cache size in bytes. Example:
1073741824.
KafkaServiceIntegration, KafkaServiceIntegrationArgs
- Integration
Type string - Type of the service integration
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration
- source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration
- source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration
- source
Service StringName - Name of the source service
KafkaTag, KafkaTagArgs
KafkaTechEmail, KafkaTechEmailArgs
- Email string
- An email address to contact for technical issues
- Email string
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
- email string
- An email address to contact for technical issues
- email str
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
Import
$ pulumi import aiven:index/kafka:Kafka example_kafka 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.