1. Packages
  2. Aiven Provider
  3. API Docs
  4. KafkaConnect
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.KafkaConnect

Explore with Pulumi AI

Creates and manages an Aiven for Apache Kafka® Connect service. Kafka Connect lets you integrate an Aiven for Apache Kafka® service with external data sources using connectors.

To set up and integrate Kafka Connect:

  1. Create a Kafka service in the same Aiven project using the aiven.Kafka resource.
  2. Create topics for importing and exporting data using aiven.KafkaTopic.
  3. Create the Kafka Connect service.
  4. Use the aiven.ServiceIntegration resource to integrate the Kafka and Kafka Connect services.
  5. Add source and sink connectors using aiven.KafkaConnector resource.

Example Usage

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

// Create a Kafka service.
const exampleKafka = new aiven.Kafka("example_kafka", {
    project: exampleProject.project,
    serviceName: "example-kafka-service",
    cloudName: "google-europe-west1",
    plan: "startup-2",
});
// Create a Kafka Connect service.
const exampleKafkaConnect = new aiven.KafkaConnect("example_kafka_connect", {
    project: exampleProject.project,
    cloudName: "google-europe-west1",
    plan: "startup-4",
    serviceName: "example-connect-service",
    kafkaConnectUserConfig: {
        kafkaConnect: {
            consumerIsolationLevel: "read_committed",
        },
        publicAccess: {
            kafkaConnect: true,
        },
    },
});
// Integrate the Kafka and Kafka Connect services.
const kafkaConnectIntegration = new aiven.ServiceIntegration("kafka_connect_integration", {
    project: exampleProject.project,
    integrationType: "kafka_connect",
    sourceServiceName: exampleKafka.serviceName,
    destinationServiceName: exampleKafkaConnect.serviceName,
    kafkaConnectUserConfig: {
        kafkaConnect: {
            groupId: "connect",
            statusStorageTopic: "__connect_status",
            offsetStorageTopic: "__connect_offsets",
        },
    },
});
Copy
import pulumi
import pulumi_aiven as aiven

# Create a Kafka service.
example_kafka = aiven.Kafka("example_kafka",
    project=example_project["project"],
    service_name="example-kafka-service",
    cloud_name="google-europe-west1",
    plan="startup-2")
# Create a Kafka Connect service.
example_kafka_connect = aiven.KafkaConnect("example_kafka_connect",
    project=example_project["project"],
    cloud_name="google-europe-west1",
    plan="startup-4",
    service_name="example-connect-service",
    kafka_connect_user_config={
        "kafka_connect": {
            "consumer_isolation_level": "read_committed",
        },
        "public_access": {
            "kafka_connect": True,
        },
    })
# Integrate the Kafka and Kafka Connect services.
kafka_connect_integration = aiven.ServiceIntegration("kafka_connect_integration",
    project=example_project["project"],
    integration_type="kafka_connect",
    source_service_name=example_kafka.service_name,
    destination_service_name=example_kafka_connect.service_name,
    kafka_connect_user_config={
        "kafka_connect": {
            "group_id": "connect",
            "status_storage_topic": "__connect_status",
            "offset_storage_topic": "__connect_offsets",
        },
    })
Copy
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 {
		// Create a Kafka service.
		exampleKafka, err := aiven.NewKafka(ctx, "example_kafka", &aiven.KafkaArgs{
			Project:     pulumi.Any(exampleProject.Project),
			ServiceName: pulumi.String("example-kafka-service"),
			CloudName:   pulumi.String("google-europe-west1"),
			Plan:        pulumi.String("startup-2"),
		})
		if err != nil {
			return err
		}
		// Create a Kafka Connect service.
		exampleKafkaConnect, err := aiven.NewKafkaConnect(ctx, "example_kafka_connect", &aiven.KafkaConnectArgs{
			Project:     pulumi.Any(exampleProject.Project),
			CloudName:   pulumi.String("google-europe-west1"),
			Plan:        pulumi.String("startup-4"),
			ServiceName: pulumi.String("example-connect-service"),
			KafkaConnectUserConfig: &aiven.KafkaConnectKafkaConnectUserConfigArgs{
				KafkaConnect: &aiven.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs{
					ConsumerIsolationLevel: pulumi.String("read_committed"),
				},
				PublicAccess: &aiven.KafkaConnectKafkaConnectUserConfigPublicAccessArgs{
					KafkaConnect: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		// Integrate the Kafka and Kafka Connect services.
		_, err = aiven.NewServiceIntegration(ctx, "kafka_connect_integration", &aiven.ServiceIntegrationArgs{
			Project:                pulumi.Any(exampleProject.Project),
			IntegrationType:        pulumi.String("kafka_connect"),
			SourceServiceName:      exampleKafka.ServiceName,
			DestinationServiceName: exampleKafkaConnect.ServiceName,
			KafkaConnectUserConfig: &aiven.ServiceIntegrationKafkaConnectUserConfigArgs{
				KafkaConnect: &aiven.ServiceIntegrationKafkaConnectUserConfigKafkaConnectArgs{
					GroupId:            pulumi.String("connect"),
					StatusStorageTopic: pulumi.String("__connect_status"),
					OffsetStorageTopic: pulumi.String("__connect_offsets"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    // Create a Kafka service.
    var exampleKafka = new Aiven.Kafka("example_kafka", new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-kafka-service",
        CloudName = "google-europe-west1",
        Plan = "startup-2",
    });

    // Create a Kafka Connect service.
    var exampleKafkaConnect = new Aiven.KafkaConnect("example_kafka_connect", new()
    {
        Project = exampleProject.Project,
        CloudName = "google-europe-west1",
        Plan = "startup-4",
        ServiceName = "example-connect-service",
        KafkaConnectUserConfig = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigArgs
        {
            KafkaConnect = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs
            {
                ConsumerIsolationLevel = "read_committed",
            },
            PublicAccess = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPublicAccessArgs
            {
                KafkaConnect = true,
            },
        },
    });

    // Integrate the Kafka and Kafka Connect services.
    var kafkaConnectIntegration = new Aiven.ServiceIntegration("kafka_connect_integration", new()
    {
        Project = exampleProject.Project,
        IntegrationType = "kafka_connect",
        SourceServiceName = exampleKafka.ServiceName,
        DestinationServiceName = exampleKafkaConnect.ServiceName,
        KafkaConnectUserConfig = new Aiven.Inputs.ServiceIntegrationKafkaConnectUserConfigArgs
        {
            KafkaConnect = new Aiven.Inputs.ServiceIntegrationKafkaConnectUserConfigKafkaConnectArgs
            {
                GroupId = "connect",
                StatusStorageTopic = "__connect_status",
                OffsetStorageTopic = "__connect_offsets",
            },
        },
    });

});
Copy
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.KafkaConnect;
import com.pulumi.aiven.KafkaConnectArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigPublicAccessArgs;
import com.pulumi.aiven.ServiceIntegration;
import com.pulumi.aiven.ServiceIntegrationArgs;
import com.pulumi.aiven.inputs.ServiceIntegrationKafkaConnectUserConfigArgs;
import com.pulumi.aiven.inputs.ServiceIntegrationKafkaConnectUserConfigKafkaConnectArgs;
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) {
        // Create a Kafka service.
        var exampleKafka = new Kafka("exampleKafka", KafkaArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-kafka-service")
            .cloudName("google-europe-west1")
            .plan("startup-2")
            .build());

        // Create a Kafka Connect service.
        var exampleKafkaConnect = new KafkaConnect("exampleKafkaConnect", KafkaConnectArgs.builder()
            .project(exampleProject.project())
            .cloudName("google-europe-west1")
            .plan("startup-4")
            .serviceName("example-connect-service")
            .kafkaConnectUserConfig(KafkaConnectKafkaConnectUserConfigArgs.builder()
                .kafkaConnect(KafkaConnectKafkaConnectUserConfigKafkaConnectArgs.builder()
                    .consumerIsolationLevel("read_committed")
                    .build())
                .publicAccess(KafkaConnectKafkaConnectUserConfigPublicAccessArgs.builder()
                    .kafkaConnect(true)
                    .build())
                .build())
            .build());

        // Integrate the Kafka and Kafka Connect services.
        var kafkaConnectIntegration = new ServiceIntegration("kafkaConnectIntegration", ServiceIntegrationArgs.builder()
            .project(exampleProject.project())
            .integrationType("kafka_connect")
            .sourceServiceName(exampleKafka.serviceName())
            .destinationServiceName(exampleKafkaConnect.serviceName())
            .kafkaConnectUserConfig(ServiceIntegrationKafkaConnectUserConfigArgs.builder()
                .kafkaConnect(ServiceIntegrationKafkaConnectUserConfigKafkaConnectArgs.builder()
                    .groupId("connect")
                    .statusStorageTopic("__connect_status")
                    .offsetStorageTopic("__connect_offsets")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  # Create a Kafka service.
  exampleKafka:
    type: aiven:Kafka
    name: example_kafka
    properties:
      project: ${exampleProject.project}
      serviceName: example-kafka-service
      cloudName: google-europe-west1
      plan: startup-2
  # Create a Kafka Connect service.
  exampleKafkaConnect:
    type: aiven:KafkaConnect
    name: example_kafka_connect
    properties:
      project: ${exampleProject.project}
      cloudName: google-europe-west1
      plan: startup-4
      serviceName: example-connect-service
      kafkaConnectUserConfig:
        kafkaConnect:
          consumerIsolationLevel: read_committed
        publicAccess:
          kafkaConnect: true
  # Integrate the Kafka and Kafka Connect services.
  kafkaConnectIntegration:
    type: aiven:ServiceIntegration
    name: kafka_connect_integration
    properties:
      project: ${exampleProject.project}
      integrationType: kafka_connect
      sourceServiceName: ${exampleKafka.serviceName}
      destinationServiceName: ${exampleKafkaConnect.serviceName}
      kafkaConnectUserConfig:
        kafkaConnect:
          groupId: connect
          statusStorageTopic: __connect_status
          offsetStorageTopic: __connect_offsets
Copy

Create KafkaConnect Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new KafkaConnect(name: string, args: KafkaConnectArgs, opts?: CustomResourceOptions);
@overload
def KafkaConnect(resource_name: str,
                 args: KafkaConnectArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def KafkaConnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 plan: Optional[str] = None,
                 service_name: Optional[str] = None,
                 project: Optional[str] = None,
                 kafka_connect_user_config: Optional[KafkaConnectKafkaConnectUserConfigArgs] = None,
                 maintenance_window_dow: Optional[str] = None,
                 maintenance_window_time: Optional[str] = None,
                 additional_disk_space: Optional[str] = None,
                 disk_space: Optional[str] = None,
                 project_vpc_id: Optional[str] = None,
                 service_integrations: Optional[Sequence[KafkaConnectServiceIntegrationArgs]] = None,
                 cloud_name: Optional[str] = None,
                 static_ips: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[KafkaConnectTagArgs]] = None,
                 tech_emails: Optional[Sequence[KafkaConnectTechEmailArgs]] = None,
                 termination_protection: Optional[bool] = None)
func NewKafkaConnect(ctx *Context, name string, args KafkaConnectArgs, opts ...ResourceOption) (*KafkaConnect, error)
public KafkaConnect(string name, KafkaConnectArgs args, CustomResourceOptions? opts = null)
public KafkaConnect(String name, KafkaConnectArgs args)
public KafkaConnect(String name, KafkaConnectArgs args, CustomResourceOptions options)
type: aiven:KafkaConnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KafkaConnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KafkaConnectArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KafkaConnectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KafkaConnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KafkaConnectArgs
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 kafkaConnectResource = new Aiven.KafkaConnect("kafkaConnectResource", new()
{
    Plan = "string",
    ServiceName = "string",
    Project = "string",
    KafkaConnectUserConfig = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigArgs
    {
        IpFilterObjects = new[]
        {
            new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs
            {
                Network = "string",
                Description = "string",
            },
        },
        IpFilterStrings = new[]
        {
            "string",
        },
        KafkaConnect = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs
        {
            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,
        },
        PluginVersions = new[]
        {
            new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPluginVersionArgs
            {
                PluginName = "string",
                Version = "string",
            },
        },
        PrivateAccess = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPrivateAccessArgs
        {
            KafkaConnect = false,
            Prometheus = false,
        },
        PrivatelinkAccess = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs
        {
            Jolokia = false,
            KafkaConnect = false,
            Prometheus = false,
        },
        PublicAccess = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPublicAccessArgs
        {
            KafkaConnect = false,
            Prometheus = false,
        },
        SecretProviders = new[]
        {
            new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigSecretProviderArgs
            {
                Name = "string",
                Aws = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigSecretProviderAwsArgs
                {
                    AuthMethod = "string",
                    Region = "string",
                    AccessKey = "string",
                    SecretKey = "string",
                },
                Vault = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigSecretProviderVaultArgs
                {
                    Address = "string",
                    AuthMethod = "string",
                    EngineVersion = 0,
                    PrefixPathDepth = 0,
                    Token = "string",
                },
            },
        },
        ServiceLog = false,
        StaticIps = false,
    },
    MaintenanceWindowDow = "string",
    MaintenanceWindowTime = "string",
    AdditionalDiskSpace = "string",
    ProjectVpcId = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.KafkaConnectServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    CloudName = "string",
    StaticIps = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Aiven.Inputs.KafkaConnectTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TechEmails = new[]
    {
        new Aiven.Inputs.KafkaConnectTechEmailArgs
        {
            Email = "string",
        },
    },
    TerminationProtection = false,
});
Copy
example, err := aiven.NewKafkaConnect(ctx, "kafkaConnectResource", &aiven.KafkaConnectArgs{
	Plan:        pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Project:     pulumi.String("string"),
	KafkaConnectUserConfig: &aiven.KafkaConnectKafkaConnectUserConfigArgs{
		IpFilterObjects: aiven.KafkaConnectKafkaConnectUserConfigIpFilterObjectArray{
			&aiven.KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs{
				Network:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
		IpFilterStrings: pulumi.StringArray{
			pulumi.String("string"),
		},
		KafkaConnect: &aiven.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs{
			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),
		},
		PluginVersions: aiven.KafkaConnectKafkaConnectUserConfigPluginVersionArray{
			&aiven.KafkaConnectKafkaConnectUserConfigPluginVersionArgs{
				PluginName: pulumi.String("string"),
				Version:    pulumi.String("string"),
			},
		},
		PrivateAccess: &aiven.KafkaConnectKafkaConnectUserConfigPrivateAccessArgs{
			KafkaConnect: pulumi.Bool(false),
			Prometheus:   pulumi.Bool(false),
		},
		PrivatelinkAccess: &aiven.KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs{
			Jolokia:      pulumi.Bool(false),
			KafkaConnect: pulumi.Bool(false),
			Prometheus:   pulumi.Bool(false),
		},
		PublicAccess: &aiven.KafkaConnectKafkaConnectUserConfigPublicAccessArgs{
			KafkaConnect: pulumi.Bool(false),
			Prometheus:   pulumi.Bool(false),
		},
		SecretProviders: aiven.KafkaConnectKafkaConnectUserConfigSecretProviderArray{
			&aiven.KafkaConnectKafkaConnectUserConfigSecretProviderArgs{
				Name: pulumi.String("string"),
				Aws: &aiven.KafkaConnectKafkaConnectUserConfigSecretProviderAwsArgs{
					AuthMethod: pulumi.String("string"),
					Region:     pulumi.String("string"),
					AccessKey:  pulumi.String("string"),
					SecretKey:  pulumi.String("string"),
				},
				Vault: &aiven.KafkaConnectKafkaConnectUserConfigSecretProviderVaultArgs{
					Address:         pulumi.String("string"),
					AuthMethod:      pulumi.String("string"),
					EngineVersion:   pulumi.Int(0),
					PrefixPathDepth: pulumi.Int(0),
					Token:           pulumi.String("string"),
				},
			},
		},
		ServiceLog: pulumi.Bool(false),
		StaticIps:  pulumi.Bool(false),
	},
	MaintenanceWindowDow:  pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	AdditionalDiskSpace:   pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	ServiceIntegrations: aiven.KafkaConnectServiceIntegrationArray{
		&aiven.KafkaConnectServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	CloudName: pulumi.String("string"),
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: aiven.KafkaConnectTagArray{
		&aiven.KafkaConnectTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TechEmails: aiven.KafkaConnectTechEmailArray{
		&aiven.KafkaConnectTechEmailArgs{
			Email: pulumi.String("string"),
		},
	},
	TerminationProtection: pulumi.Bool(false),
})
Copy
var kafkaConnectResource = new KafkaConnect("kafkaConnectResource", KafkaConnectArgs.builder()
    .plan("string")
    .serviceName("string")
    .project("string")
    .kafkaConnectUserConfig(KafkaConnectKafkaConnectUserConfigArgs.builder()
        .ipFilterObjects(KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs.builder()
            .network("string")
            .description("string")
            .build())
        .ipFilterStrings("string")
        .kafkaConnect(KafkaConnectKafkaConnectUserConfigKafkaConnectArgs.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())
        .pluginVersions(KafkaConnectKafkaConnectUserConfigPluginVersionArgs.builder()
            .pluginName("string")
            .version("string")
            .build())
        .privateAccess(KafkaConnectKafkaConnectUserConfigPrivateAccessArgs.builder()
            .kafkaConnect(false)
            .prometheus(false)
            .build())
        .privatelinkAccess(KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs.builder()
            .jolokia(false)
            .kafkaConnect(false)
            .prometheus(false)
            .build())
        .publicAccess(KafkaConnectKafkaConnectUserConfigPublicAccessArgs.builder()
            .kafkaConnect(false)
            .prometheus(false)
            .build())
        .secretProviders(KafkaConnectKafkaConnectUserConfigSecretProviderArgs.builder()
            .name("string")
            .aws(KafkaConnectKafkaConnectUserConfigSecretProviderAwsArgs.builder()
                .authMethod("string")
                .region("string")
                .accessKey("string")
                .secretKey("string")
                .build())
            .vault(KafkaConnectKafkaConnectUserConfigSecretProviderVaultArgs.builder()
                .address("string")
                .authMethod("string")
                .engineVersion(0)
                .prefixPathDepth(0)
                .token("string")
                .build())
            .build())
        .serviceLog(false)
        .staticIps(false)
        .build())
    .maintenanceWindowDow("string")
    .maintenanceWindowTime("string")
    .additionalDiskSpace("string")
    .projectVpcId("string")
    .serviceIntegrations(KafkaConnectServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .cloudName("string")
    .staticIps("string")
    .tags(KafkaConnectTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .techEmails(KafkaConnectTechEmailArgs.builder()
        .email("string")
        .build())
    .terminationProtection(false)
    .build());
Copy
kafka_connect_resource = aiven.KafkaConnect("kafkaConnectResource",
    plan="string",
    service_name="string",
    project="string",
    kafka_connect_user_config={
        "ip_filter_objects": [{
            "network": "string",
            "description": "string",
        }],
        "ip_filter_strings": ["string"],
        "kafka_connect": {
            "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,
        },
        "plugin_versions": [{
            "plugin_name": "string",
            "version": "string",
        }],
        "private_access": {
            "kafka_connect": False,
            "prometheus": False,
        },
        "privatelink_access": {
            "jolokia": False,
            "kafka_connect": False,
            "prometheus": False,
        },
        "public_access": {
            "kafka_connect": False,
            "prometheus": False,
        },
        "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",
            },
        }],
        "service_log": False,
        "static_ips": False,
    },
    maintenance_window_dow="string",
    maintenance_window_time="string",
    additional_disk_space="string",
    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)
Copy
const kafkaConnectResource = new aiven.KafkaConnect("kafkaConnectResource", {
    plan: "string",
    serviceName: "string",
    project: "string",
    kafkaConnectUserConfig: {
        ipFilterObjects: [{
            network: "string",
            description: "string",
        }],
        ipFilterStrings: ["string"],
        kafkaConnect: {
            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,
        },
        pluginVersions: [{
            pluginName: "string",
            version: "string",
        }],
        privateAccess: {
            kafkaConnect: false,
            prometheus: false,
        },
        privatelinkAccess: {
            jolokia: false,
            kafkaConnect: false,
            prometheus: false,
        },
        publicAccess: {
            kafkaConnect: false,
            prometheus: false,
        },
        secretProviders: [{
            name: "string",
            aws: {
                authMethod: "string",
                region: "string",
                accessKey: "string",
                secretKey: "string",
            },
            vault: {
                address: "string",
                authMethod: "string",
                engineVersion: 0,
                prefixPathDepth: 0,
                token: "string",
            },
        }],
        serviceLog: false,
        staticIps: false,
    },
    maintenanceWindowDow: "string",
    maintenanceWindowTime: "string",
    additionalDiskSpace: "string",
    projectVpcId: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    cloudName: "string",
    staticIps: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    techEmails: [{
        email: "string",
    }],
    terminationProtection: false,
});
Copy
type: aiven:KafkaConnect
properties:
    additionalDiskSpace: string
    cloudName: string
    kafkaConnectUserConfig:
        ipFilterObjects:
            - description: string
              network: string
        ipFilterStrings:
            - string
        kafkaConnect:
            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
        pluginVersions:
            - pluginName: string
              version: string
        privateAccess:
            kafkaConnect: false
            prometheus: false
        privatelinkAccess:
            jolokia: false
            kafkaConnect: false
            prometheus: false
        publicAccess:
            kafkaConnect: false
            prometheus: false
        secretProviders:
            - aws:
                accessKey: string
                authMethod: string
                region: string
                secretKey: string
              name: string
              vault:
                address: string
                authMethod: string
                engineVersion: 0
                prefixPathDepth: 0
                token: string
        serviceLog: false
        staticIps: false
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    tags:
        - key: string
          value: string
    techEmails:
        - email: string
    terminationProtection: false
Copy

KafkaConnect 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 KafkaConnect resource accepts the following input properties:

Plan This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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.
AdditionalDiskSpace string
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.
CloudName 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.
DiskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
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.
ServiceIntegrations List<KafkaConnectServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps 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
Tags List<KafkaConnectTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<KafkaConnectTechEmail>
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.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for 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 This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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.
AdditionalDiskSpace string
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.
CloudName 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.
DiskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfigArgs
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
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.
ServiceIntegrations []KafkaConnectServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps []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
Tags []KafkaConnectTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []KafkaConnectTechEmailArgs
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.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for 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 This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
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.
additionalDiskSpace String
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.
cloudName 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.
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
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.
serviceIntegrations List<KafkaConnectServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps 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
tags List<KafkaConnectTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<KafkaConnectTechEmail>
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.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for 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 This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
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.
additionalDiskSpace string
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.
cloudName 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.
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId string
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.
serviceIntegrations KafkaConnectServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps 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
tags KafkaConnectTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails KafkaConnectTechEmail[]
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.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for 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 This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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_space str
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.
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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafka_connect_user_config KafkaConnectKafkaConnectUserConfigArgs
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
project_vpc_id str
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[KafkaConnectServiceIntegrationArgs]
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
tags Sequence[KafkaConnectTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[KafkaConnectTechEmailArgs]
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 true for 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 This property is required. 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-x and premium-x where x is (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
This property is required.
Changes to this property will trigger replacement.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
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.
additionalDiskSpace String
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.
cloudName 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.
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig Property Map
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
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.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps 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
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails 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.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for 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 KafkaConnect resource produces the following output properties:

Components List<KafkaConnectComponent>
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
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
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
Components []KafkaConnectComponent
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
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
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
components List<KafkaConnectComponent>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
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
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
components KafkaConnectComponent[]
Service component information objects
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
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
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id string
The provider-assigned unique ID for this managed resource.
serviceHost string
The hostname of the service.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
components Sequence[KafkaConnectComponent]
Service component information objects
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
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_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

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
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
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
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String

Look up Existing KafkaConnect Resource

Get an existing KafkaConnect 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?: KafkaConnectState, opts?: CustomResourceOptions): KafkaConnect
@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[KafkaConnectComponentArgs]] = 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_connect_user_config: Optional[KafkaConnectKafkaConnectUserConfigArgs] = 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[KafkaConnectServiceIntegrationArgs]] = 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[KafkaConnectTagArgs]] = None,
        tech_emails: Optional[Sequence[KafkaConnectTechEmailArgs]] = None,
        termination_protection: Optional[bool] = None) -> KafkaConnect
func GetKafkaConnect(ctx *Context, name string, id IDInput, state *KafkaConnectState, opts ...ResourceOption) (*KafkaConnect, error)
public static KafkaConnect Get(string name, Input<string> id, KafkaConnectState? state, CustomResourceOptions? opts = null)
public static KafkaConnect get(String name, Output<String> id, KafkaConnectState state, CustomResourceOptions options)
resources:  _:    type: aiven:KafkaConnect    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AdditionalDiskSpace string
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.
CloudName 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<KafkaConnectComponent>
Service component information objects
DiskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
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
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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.
ProjectVpcId string
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.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<KafkaConnectServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. 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.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps 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
Tags List<KafkaConnectTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<KafkaConnectTechEmail>
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.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for 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.
AdditionalDiskSpace string
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.
CloudName 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 []KafkaConnectComponentArgs
Service component information objects
DiskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
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
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfigArgs
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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.
ProjectVpcId string
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.
ServiceHost string
The hostname of the service.
ServiceIntegrations []KafkaConnectServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. 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.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []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
Tags []KafkaConnectTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []KafkaConnectTechEmailArgs
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.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for 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.
additionalDiskSpace String
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.
cloudName 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<KafkaConnectComponent>
Service component information objects
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
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
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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.
projectVpcId String
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.
serviceHost String
The hostname of the service.
serviceIntegrations List<KafkaConnectServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. 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.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps 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
tags List<KafkaConnectTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<KafkaConnectTechEmail>
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.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for 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.
additionalDiskSpace string
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.
cloudName 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 KafkaConnectComponent[]
Service component information objects
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
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
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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.
projectVpcId string
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.
serviceHost string
The hostname of the service.
serviceIntegrations KafkaConnectServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. 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.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps 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
tags KafkaConnectTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails KafkaConnectTechEmail[]
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.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for 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_space str
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[KafkaConnectComponentArgs]
Service component information objects
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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
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_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafka_connect_user_config KafkaConnectKafkaConnectUserConfigArgs
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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_id str
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[KafkaConnectServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name Changes to this property will trigger replacement. 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
tags Sequence[KafkaConnectTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[KafkaConnectTechEmailArgs]
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 true for 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.
additionalDiskSpace String
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.
cloudName 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
diskSpace 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.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
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
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaConnectUserConfig Property Map
KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
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-x and premium-x where x is (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 Changes to this property will trigger replacement. 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.
projectVpcId String
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.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. 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.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps 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
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails 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.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for 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

KafkaConnectComponent
, KafkaConnectComponentArgs

Component string
Service component name
ConnectionUri 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
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_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
ConnectionUri 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
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_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
connectionUri 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
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_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
connectionUri 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
kafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_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_method str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str
Kafka certificate used. The possible values are letsencrypt and project_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
connectionUri 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
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_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

KafkaConnectKafkaConnectUserConfig
, KafkaConnectKafkaConnectUserConfigArgs

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

IpFilterObjects List<KafkaConnectKafkaConnectUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect
Kafka Connect configuration values
PluginVersions List<KafkaConnectKafkaConnectUserConfigPluginVersion>
The plugin selected by the user
PrivateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
PublicAccess KafkaConnectKafkaConnectUserConfigPublicAccess
Allow access to selected service ports from the public Internet
SecretProviders List<KafkaConnectKafkaConnectUserConfigSecretProvider>
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

IpFilterObjects []KafkaConnectKafkaConnectUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect
Kafka Connect configuration values
PluginVersions []KafkaConnectKafkaConnectUserConfigPluginVersion
The plugin selected by the user
PrivateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess
Allow access to selected service ports from private networks
PrivatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
PublicAccess KafkaConnectKafkaConnectUserConfigPublicAccess
Allow access to selected service ports from the public Internet
SecretProviders []KafkaConnectKafkaConnectUserConfigSecretProvider
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects List<KafkaConnectKafkaConnectUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect
Kafka Connect configuration values
pluginVersions List<KafkaConnectKafkaConnectUserConfigPluginVersion>
The plugin selected by the user
privateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
publicAccess KafkaConnectKafkaConnectUserConfigPublicAccess
Allow access to selected service ports from the public Internet
secretProviders List<KafkaConnectKafkaConnectUserConfigSecretProvider>
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects KafkaConnectKafkaConnectUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect
Kafka Connect configuration values
pluginVersions KafkaConnectKafkaConnectUserConfigPluginVersion[]
The plugin selected by the user
privateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
publicAccess KafkaConnectKafkaConnectUserConfigPublicAccess
Allow access to selected service ports from the public Internet
secretProviders KafkaConnectKafkaConnectUserConfigSecretProvider[]
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps boolean
Use static public IP addresses.
additional_backup_regions str
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ip_filter_objects Sequence[KafkaConnectKafkaConnectUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
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.

Deprecated: Deprecated. Use ip_filter_string instead.

kafka_connect KafkaConnectKafkaConnectUserConfigKafkaConnect
Kafka Connect configuration values
plugin_versions Sequence[KafkaConnectKafkaConnectUserConfigPluginVersion]
The plugin selected by the user
private_access KafkaConnectKafkaConnectUserConfigPrivateAccess
Allow access to selected service ports from private networks
privatelink_access KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
public_access KafkaConnectKafkaConnectUserConfigPublicAccess
Allow access to selected service ports from the public Internet
secret_providers Sequence[KafkaConnectKafkaConnectUserConfigSecretProvider]
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
static_ips bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaConnect Property Map
Kafka Connect configuration values
pluginVersions List<Property Map>
The plugin selected by the user
privateAccess Property Map
Allow access to selected service ports from private networks
privatelinkAccess Property Map
Allow access to selected service components through Privatelink
publicAccess Property Map
Allow access to selected service ports from the public Internet
secretProviders List<Property Map>
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.

KafkaConnectKafkaConnectUserConfigIpFilterObject
, KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

KafkaConnectKafkaConnectUserConfigKafkaConnect
, KafkaConnectKafkaConnectUserConfigKafkaConnectArgs

ConnectorClientConfigOverridePolicy string
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
ConsumerAutoOffsetReset string
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.
ConsumerFetchMaxBytes int
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.
ConsumerIsolationLevel string
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.
ConsumerMaxPartitionFetchBytes int
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.
ConsumerMaxPollIntervalMs int
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
ConsumerMaxPollRecords int
The maximum number of records returned in a single call to poll() (defaults to 500).
OffsetFlushIntervalMs int
The interval at which to try committing offsets for tasks (defaults to 60000).
OffsetFlushTimeoutMs int
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).
ProducerBatchSize int
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 linger for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
ProducerBufferMemory int
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
ProducerCompressionType string
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 accepts none which is the default and equivalent to no compression.
ProducerLingerMs int
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 linger for the specified time waiting for more records to show up. Defaults to 0.
ProducerMaxRequestSize int
This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
ScheduledRebalanceMaxDelayMs int
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.
SessionTimeoutMs int
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
ConnectorClientConfigOverridePolicy string
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
ConsumerAutoOffsetReset string
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.
ConsumerFetchMaxBytes int
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.
ConsumerIsolationLevel string
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.
ConsumerMaxPartitionFetchBytes int
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.
ConsumerMaxPollIntervalMs int
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
ConsumerMaxPollRecords int
The maximum number of records returned in a single call to poll() (defaults to 500).
OffsetFlushIntervalMs int
The interval at which to try committing offsets for tasks (defaults to 60000).
OffsetFlushTimeoutMs int
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).
ProducerBatchSize int
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 linger for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
ProducerBufferMemory int
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
ProducerCompressionType string
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 accepts none which is the default and equivalent to no compression.
ProducerLingerMs int
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 linger for the specified time waiting for more records to show up. Defaults to 0.
ProducerMaxRequestSize int
This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
ScheduledRebalanceMaxDelayMs int
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.
SessionTimeoutMs int
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
connectorClientConfigOverridePolicy String
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
consumerAutoOffsetReset String
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.
consumerFetchMaxBytes Integer
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.
consumerIsolationLevel String
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.
consumerMaxPartitionFetchBytes Integer
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.
consumerMaxPollIntervalMs Integer
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
consumerMaxPollRecords Integer
The maximum number of records returned in a single call to poll() (defaults to 500).
offsetFlushIntervalMs Integer
The interval at which to try committing offsets for tasks (defaults to 60000).
offsetFlushTimeoutMs Integer
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).
producerBatchSize Integer
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 linger for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
producerBufferMemory Integer
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
producerCompressionType String
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 accepts none which is the default and equivalent to no compression.
producerLingerMs Integer
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 linger for the specified time waiting for more records to show up. Defaults to 0.
producerMaxRequestSize Integer
This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
scheduledRebalanceMaxDelayMs Integer
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.
sessionTimeoutMs Integer
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
connectorClientConfigOverridePolicy string
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
consumerAutoOffsetReset string
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.
consumerFetchMaxBytes number
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.
consumerIsolationLevel string
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.
consumerMaxPartitionFetchBytes number
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.
consumerMaxPollIntervalMs number
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
consumerMaxPollRecords number
The maximum number of records returned in a single call to poll() (defaults to 500).
offsetFlushIntervalMs number
The interval at which to try committing offsets for tasks (defaults to 60000).
offsetFlushTimeoutMs number
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).
producerBatchSize number
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 linger for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
producerBufferMemory number
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
producerCompressionType string
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 accepts none which is the default and equivalent to no compression.
producerLingerMs number
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 linger for the specified time waiting for more records to show up. Defaults to 0.
producerMaxRequestSize number
This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
scheduledRebalanceMaxDelayMs number
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.
sessionTimeoutMs number
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
connector_client_config_override_policy str
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
consumer_auto_offset_reset str
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_max_bytes int
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_level str
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_partition_fetch_bytes int
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_poll_interval_ms int
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
consumer_max_poll_records int
The maximum number of records returned in a single call to poll() (defaults to 500).
offset_flush_interval_ms int
The interval at which to try committing offsets for tasks (defaults to 60000).
offset_flush_timeout_ms int
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_size int
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 linger for 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_memory int
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
producer_compression_type str
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 accepts none which is the default and equivalent to no compression.
producer_linger_ms int
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 linger for the specified time waiting for more records to show up. Defaults to 0.
producer_max_request_size int
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_max_delay_ms int
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_ms int
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
connectorClientConfigOverridePolicy String
Enum: All, None. Defines what client configurations can be overridden by the connector. Default is None.
consumerAutoOffsetReset String
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.
consumerFetchMaxBytes Number
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.
consumerIsolationLevel String
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.
consumerMaxPartitionFetchBytes Number
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.
consumerMaxPollIntervalMs Number
The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
consumerMaxPollRecords Number
The maximum number of records returned in a single call to poll() (defaults to 500).
offsetFlushIntervalMs Number
The interval at which to try committing offsets for tasks (defaults to 60000).
offsetFlushTimeoutMs Number
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).
producerBatchSize Number
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 linger for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
producerBufferMemory Number
The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
producerCompressionType String
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 accepts none which is the default and equivalent to no compression.
producerLingerMs Number
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 linger for the specified time waiting for more records to show up. Defaults to 0.
producerMaxRequestSize Number
This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
scheduledRebalanceMaxDelayMs Number
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.
sessionTimeoutMs Number
The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).

KafkaConnectKafkaConnectUserConfigPluginVersion
, KafkaConnectKafkaConnectUserConfigPluginVersionArgs

PluginName This property is required. string
The name of the plugin. Example: debezium-connector.
Version This property is required. string
The version of the plugin. Example: 2.5.0.
PluginName This property is required. string
The name of the plugin. Example: debezium-connector.
Version This property is required. string
The version of the plugin. Example: 2.5.0.
pluginName This property is required. String
The name of the plugin. Example: debezium-connector.
version This property is required. String
The version of the plugin. Example: 2.5.0.
pluginName This property is required. string
The name of the plugin. Example: debezium-connector.
version This property is required. string
The version of the plugin. Example: 2.5.0.
plugin_name This property is required. str
The name of the plugin. Example: debezium-connector.
version This property is required. str
The version of the plugin. Example: 2.5.0.
pluginName This property is required. String
The name of the plugin. Example: debezium-connector.
version This property is required. String
The version of the plugin. Example: 2.5.0.

KafkaConnectKafkaConnectUserConfigPrivateAccess
, KafkaConnectKafkaConnectUserConfigPrivateAccessArgs

KafkaConnect 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.
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.
KafkaConnect 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.
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.
kafkaConnect 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.
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.
kafkaConnect 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.
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.
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.
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.
kafkaConnect 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.
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.

KafkaConnectKafkaConnectUserConfigPrivatelinkAccess
, KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs

Jolokia bool
Enable jolokia.
KafkaConnect bool
Enable kafka_connect.
Prometheus bool
Enable prometheus.
Jolokia bool
Enable jolokia.
KafkaConnect bool
Enable kafka_connect.
Prometheus bool
Enable prometheus.
jolokia Boolean
Enable jolokia.
kafkaConnect Boolean
Enable kafka_connect.
prometheus Boolean
Enable prometheus.
jolokia boolean
Enable jolokia.
kafkaConnect boolean
Enable kafka_connect.
prometheus boolean
Enable prometheus.
jolokia bool
Enable jolokia.
kafka_connect bool
Enable kafka_connect.
prometheus bool
Enable prometheus.
jolokia Boolean
Enable jolokia.
kafkaConnect Boolean
Enable kafka_connect.
prometheus Boolean
Enable prometheus.

KafkaConnectKafkaConnectUserConfigPublicAccess
, KafkaConnectKafkaConnectUserConfigPublicAccessArgs

KafkaConnect 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.
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.
KafkaConnect 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.
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.
kafkaConnect 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.
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.
kafkaConnect 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.
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.
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.
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.
kafkaConnect 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.
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.

KafkaConnectKafkaConnectUserConfigSecretProvider
, KafkaConnectKafkaConnectUserConfigSecretProviderArgs

Name This property is required. string
Name of the secret provider. Used to reference secrets in connector config.
Aws KafkaConnectKafkaConnectUserConfigSecretProviderAws
AWS secret provider configuration
Vault KafkaConnectKafkaConnectUserConfigSecretProviderVault
Vault secret provider configuration
Name This property is required. string
Name of the secret provider. Used to reference secrets in connector config.
Aws KafkaConnectKafkaConnectUserConfigSecretProviderAws
AWS secret provider configuration
Vault KafkaConnectKafkaConnectUserConfigSecretProviderVault
Vault secret provider configuration
name This property is required. String
Name of the secret provider. Used to reference secrets in connector config.
aws KafkaConnectKafkaConnectUserConfigSecretProviderAws
AWS secret provider configuration
vault KafkaConnectKafkaConnectUserConfigSecretProviderVault
Vault secret provider configuration
name This property is required. string
Name of the secret provider. Used to reference secrets in connector config.
aws KafkaConnectKafkaConnectUserConfigSecretProviderAws
AWS secret provider configuration
vault KafkaConnectKafkaConnectUserConfigSecretProviderVault
Vault secret provider configuration
name This property is required. str
Name of the secret provider. Used to reference secrets in connector config.
aws KafkaConnectKafkaConnectUserConfigSecretProviderAws
AWS secret provider configuration
vault KafkaConnectKafkaConnectUserConfigSecretProviderVault
Vault secret provider configuration
name This property is required. 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

KafkaConnectKafkaConnectUserConfigSecretProviderAws
, KafkaConnectKafkaConnectUserConfigSecretProviderAwsArgs

AuthMethod This property is required. string
Enum: credentials. Auth method of the vault secret provider.
Region This property is required. string
Region used to lookup secrets with AWS SecretManager.
AccessKey string
Access key used to authenticate with aws.
SecretKey string
Secret key used to authenticate with aws.
AuthMethod This property is required. string
Enum: credentials. Auth method of the vault secret provider.
Region This property is required. string
Region used to lookup secrets with AWS SecretManager.
AccessKey string
Access key used to authenticate with aws.
SecretKey string
Secret key used to authenticate with aws.
authMethod This property is required. String
Enum: credentials. Auth method of the vault secret provider.
region This property is required. String
Region used to lookup secrets with AWS SecretManager.
accessKey String
Access key used to authenticate with aws.
secretKey String
Secret key used to authenticate with aws.
authMethod This property is required. string
Enum: credentials. Auth method of the vault secret provider.
region This property is required. string
Region used to lookup secrets with AWS SecretManager.
accessKey string
Access key used to authenticate with aws.
secretKey string
Secret key used to authenticate with aws.
auth_method This property is required. str
Enum: credentials. Auth method of the vault secret provider.
region This property is required. 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.
authMethod This property is required. String
Enum: credentials. Auth method of the vault secret provider.
region This property is required. String
Region used to lookup secrets with AWS SecretManager.
accessKey String
Access key used to authenticate with aws.
secretKey String
Secret key used to authenticate with aws.

KafkaConnectKafkaConnectUserConfigSecretProviderVault
, KafkaConnectKafkaConnectUserConfigSecretProviderVaultArgs

Address This property is required. string
Address of the Vault server.
AuthMethod This property is required. string
Enum: token. Auth method of the vault secret provider.
EngineVersion int
Enum: 1, 2, and newer. KV Secrets Engine version of the Vault server instance.
PrefixPathDepth int
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 This property is required. string
Address of the Vault server.
AuthMethod This property is required. string
Enum: token. Auth method of the vault secret provider.
EngineVersion int
Enum: 1, 2, and newer. KV Secrets Engine version of the Vault server instance.
PrefixPathDepth int
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 This property is required. String
Address of the Vault server.
authMethod This property is required. String
Enum: token. Auth method of the vault secret provider.
engineVersion Integer
Enum: 1, 2, and newer. KV Secrets Engine version of the Vault server instance.
prefixPathDepth Integer
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 This property is required. string
Address of the Vault server.
authMethod This property is required. string
Enum: token. Auth method of the vault secret provider.
engineVersion number
Enum: 1, 2, and newer. KV Secrets Engine version of the Vault server instance.
prefixPathDepth number
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 This property is required. str
Address of the Vault server.
auth_method This property is required. 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_depth int
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 This property is required. String
Address of the Vault server.
authMethod This property is required. String
Enum: token. Auth method of the vault secret provider.
engineVersion Number
Enum: 1, 2, and newer. KV Secrets Engine version of the Vault server instance.
prefixPathDepth Number
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.

KafkaConnectServiceIntegration
, KafkaConnectServiceIntegrationArgs

IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service

KafkaConnectTag
, KafkaConnectTagArgs

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

KafkaConnectTechEmail
, KafkaConnectTechEmailArgs

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

Import

$ pulumi import aiven:index/kafkaConnect:KafkaConnect example_kafka_connect PROJECT/SERVICE_NAME
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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