Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
aiven.getKafkaConnect
Explore with Pulumi AI
Gets information about an Aiven for Apache Kafka® Connect service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleKafkaConnect = aiven.getKafkaConnect({
    project: exampleProject.project,
    serviceName: "example-connect-service",
});
import pulumi
import pulumi_aiven as aiven
example_kafka_connect = aiven.get_kafka_connect(project=example_project["project"],
    service_name="example-connect-service")
package main
import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupKafkaConnect(ctx, &aiven.LookupKafkaConnectArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-connect-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() => 
{
    var exampleKafkaConnect = Aiven.GetKafkaConnect.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-connect-service",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetKafkaConnectArgs;
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) {
        final var exampleKafkaConnect = AivenFunctions.getKafkaConnect(GetKafkaConnectArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-connect-service")
            .build());
    }
}
variables:
  exampleKafkaConnect:
    fn::invoke:
      function: aiven:getKafkaConnect
      arguments:
        project: ${exampleProject.project}
        serviceName: example-connect-service
Using getKafkaConnect
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getKafkaConnect(args: GetKafkaConnectArgs, opts?: InvokeOptions): Promise<GetKafkaConnectResult>
function getKafkaConnectOutput(args: GetKafkaConnectOutputArgs, opts?: InvokeOptions): Output<GetKafkaConnectResult>def get_kafka_connect(project: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKafkaConnectResult
def get_kafka_connect_output(project: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKafkaConnectResult]func LookupKafkaConnect(ctx *Context, args *LookupKafkaConnectArgs, opts ...InvokeOption) (*LookupKafkaConnectResult, error)
func LookupKafkaConnectOutput(ctx *Context, args *LookupKafkaConnectOutputArgs, opts ...InvokeOption) LookupKafkaConnectResultOutput> Note: This function is named LookupKafkaConnect in the Go SDK.
public static class GetKafkaConnect 
{
    public static Task<GetKafkaConnectResult> InvokeAsync(GetKafkaConnectArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaConnectResult> Invoke(GetKafkaConnectInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKafkaConnectResult> getKafkaConnect(GetKafkaConnectArgs args, InvokeOptions options)
public static Output<GetKafkaConnectResult> getKafkaConnect(GetKafkaConnectArgs args, InvokeOptions options)
fn::invoke:
  function: aiven:index/getKafkaConnect:getKafkaConnect
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ServiceName 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.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ServiceName 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.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName 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.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName 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.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- service_name str
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- serviceName 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.
getKafkaConnect Result
The following output properties are available:
- AdditionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- 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<GetKafka Connect Component> 
- 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.
- DiskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- DiskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- DiskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- DiskSpace stringUsed 
- Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- KafkaConnect List<GetUser Configs Kafka Connect Kafka Connect User Config> 
- KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- MaintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- MaintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ProjectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- ServiceHost string
- The hostname of the service.
- ServiceIntegrations List<GetKafka Connect Service Integration> 
- Service integrations to specify when creating a service. Not applied after initial service creation
- ServiceName 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
- 
List<GetKafka Connect Tag> 
- Tags are key-value pairs that allow you to categorize services.
- TechEmails List<GetKafka Connect Tech Email> 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- TerminationProtection bool
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- AdditionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- 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
[]GetKafka Connect Component 
- 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.
- DiskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- DiskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- DiskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- DiskSpace stringUsed 
- Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- KafkaConnect []GetUser Configs Kafka Connect Kafka Connect User Config 
- KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- MaintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- MaintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- Project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- ProjectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- ServiceHost string
- The hostname of the service.
- ServiceIntegrations []GetKafka Connect Service Integration 
- Service integrations to specify when creating a service. Not applied after initial service creation
- ServiceName 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
- 
[]GetKafka Connect Tag 
- Tags are key-value pairs that allow you to categorize services.
- TechEmails []GetKafka Connect Tech Email 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- TerminationProtection bool
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additionalDisk StringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- 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<GetKafka Connect Component> 
- 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.
- diskSpace StringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace StringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace StringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace StringUsed 
- Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- kafkaConnect List<GetUser Configs Kafka Connect Kafka Connect User Config> 
- KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenanceWindow StringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow StringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc StringId 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- serviceHost String
- The hostname of the service.
- serviceIntegrations List<GetKafka Connect Service Integration> 
- Service integrations to specify when creating a service. Not applied after initial service creation
- serviceName 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
- 
List<GetKafka Connect Tag> 
- Tags are key-value pairs that allow you to categorize services.
- techEmails List<GetKafka Connect Tech Email> 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- terminationProtection Boolean
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additionalDisk stringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- 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
GetKafka Connect Component[] 
- 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.
- diskSpace stringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace stringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace stringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace stringUsed 
- Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- kafkaConnect GetUser Configs Kafka Connect Kafka Connect User Config[] 
- KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenanceWindow stringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow stringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project string
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc stringId 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- serviceHost string
- The hostname of the service.
- serviceIntegrations GetKafka Connect Service Integration[] 
- Service integrations to specify when creating a service. Not applied after initial service creation
- serviceName 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
- 
GetKafka Connect Tag[] 
- Tags are key-value pairs that allow you to categorize services.
- techEmails GetKafka Connect Tech Email[] 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- terminationProtection boolean
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional_disk_ strspace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- cloud_name str
- The cloud provider and region the service is hosted in. The format is provider-region, for example:google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
- components
Sequence[GetKafka Connect Component] 
- 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.
- disk_space_ strcap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_space_ strdefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- disk_space_ strstep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- disk_space_ strused 
- Disk space that service is currently using
- id str
- The provider-assigned unique ID for this managed resource.
- kafka_connect_ Sequence[Getuser_ configs Kafka Connect Kafka Connect User Config] 
- 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_ strdow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_window_ strtime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- project_vpc_ strid 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_host str
- The hostname of the service.
- service_integrations Sequence[GetKafka Connect Service Integration] 
- Service integrations to specify when creating a service. Not applied after initial service creation
- service_name str
- Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_password str
- Password used for connecting to the service, if applicable
- service_port int
- The port of the service
- service_type str
- Aiven internal service type code
- service_uri str
- URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_username str
- Username used for connecting to the service, if applicable
- state str
- static_ips Sequence[str]
- Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- 
Sequence[GetKafka Connect Tag] 
- Tags are key-value pairs that allow you to categorize services.
- tech_emails Sequence[GetKafka Connect Tech Email] 
- The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
- termination_protection bool
- Prevents the service from being deleted. It is recommended to set this to truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additionalDisk StringSpace 
- Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
- 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.
- diskSpace StringCap 
- The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- diskSpace StringDefault 
- The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
- diskSpace StringStep 
- The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_spaceneeds to increment fromdisk_space_defaultby increments of this size.
- diskSpace StringUsed 
- Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- kafkaConnect List<Property Map>User Configs 
- KafkaConnect user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenanceWindow StringDow 
- Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenanceWindow StringTime 
- Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
- Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist,startup-x,business-xandpremium-xwherexis (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
- project String
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- projectVpc StringId 
- Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- 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 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
- 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 truefor all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Supporting Types
GetKafkaConnectComponent   
- 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
- KafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- KafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- Component string
- Service component name
- 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
- KafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- KafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- component String
- Service component name
- 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
- kafkaAuthentication StringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl StringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port Integer
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
- component string
- Service component name
- 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
- kafkaAuthentication stringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl stringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port number
- Port number for connecting to the service component
- route string
- Network access route
- ssl boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage string
- DNS usage name
- component str
- Service component name
- connection_uri str
- Connection info for connecting to the service component. This is a combination of host and port.
- host str
- Host name for connecting to the service component
- kafka_authentication_ strmethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafka_ssl_ strca 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port int
- Port number for connecting to the service component
- route str
- Network access route
- ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage str
- DNS usage name
- component String
- Service component name
- 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
- kafkaAuthentication StringMethod 
- Kafka authentication method. This is a value specific to the 'kafka' service component
- kafkaSsl StringCa 
- Kafka certificate used. The possible values are letsencryptandproject_ca.
- port Number
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
GetKafkaConnectKafkaConnectUserConfig      
- AdditionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- IpFilter List<GetObjects Kafka Connect Kafka Connect User Config Ip Filter Object> 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- IpFilter List<string>Strings 
- 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.
- KafkaConnect GetKafka Connect Kafka Connect User Config Kafka Connect 
- Kafka Connect configuration values
- PluginVersions List<GetKafka Connect Kafka Connect User Config Plugin Version> 
- The plugin selected by the user
- PrivateAccess GetKafka Connect Kafka Connect User Config Private Access 
- Allow access to selected service ports from private networks
- PrivatelinkAccess GetKafka Connect Kafka Connect User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- PublicAccess GetKafka Connect Kafka Connect User Config Public Access 
- Allow access to selected service ports from the public Internet
- SecretProviders List<GetKafka Connect Kafka Connect User Config Secret Provider> 
- 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.
- AdditionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- IpFilter []GetObjects Kafka Connect Kafka Connect User Config Ip Filter Object 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- IpFilter []stringStrings 
- 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.
- KafkaConnect GetKafka Connect Kafka Connect User Config Kafka Connect 
- Kafka Connect configuration values
- PluginVersions []GetKafka Connect Kafka Connect User Config Plugin Version 
- The plugin selected by the user
- PrivateAccess GetKafka Connect Kafka Connect User Config Private Access 
- Allow access to selected service ports from private networks
- PrivatelinkAccess GetKafka Connect Kafka Connect User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- PublicAccess GetKafka Connect Kafka Connect User Config Public Access 
- Allow access to selected service ports from the public Internet
- SecretProviders []GetKafka Connect Kafka Connect User Config Secret Provider 
- 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.
- additionalBackup StringRegions 
- Additional Cloud Regions for Backup Replication.
- ipFilter List<GetObjects Kafka Connect Kafka Connect User Config Ip Filter Object> 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter List<String>Strings 
- 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.
- kafkaConnect GetKafka Connect Kafka Connect User Config Kafka Connect 
- Kafka Connect configuration values
- pluginVersions List<GetKafka Connect Kafka Connect User Config Plugin Version> 
- The plugin selected by the user
- privateAccess GetKafka Connect Kafka Connect User Config Private Access 
- Allow access to selected service ports from private networks
- privatelinkAccess GetKafka Connect Kafka Connect User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- publicAccess GetKafka Connect Kafka Connect User Config Public Access 
- Allow access to selected service ports from the public Internet
- secretProviders List<GetKafka Connect Kafka Connect User Config Secret Provider> 
- 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.
- additionalBackup stringRegions 
- Additional Cloud Regions for Backup Replication.
- ipFilter GetObjects Kafka Connect Kafka Connect User Config Ip Filter Object[] 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter string[]Strings 
- 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.
- kafkaConnect GetKafka Connect Kafka Connect User Config Kafka Connect 
- Kafka Connect configuration values
- pluginVersions GetKafka Connect Kafka Connect User Config Plugin Version[] 
- The plugin selected by the user
- privateAccess GetKafka Connect Kafka Connect User Config Private Access 
- Allow access to selected service ports from private networks
- privatelinkAccess GetKafka Connect Kafka Connect User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- publicAccess GetKafka Connect Kafka Connect User Config Public Access 
- Allow access to selected service ports from the public Internet
- secretProviders GetKafka Connect Kafka Connect User Config Secret Provider[] 
- 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_ strregions 
- Additional Cloud Regions for Backup Replication.
- ip_filter_ Sequence[Getobjects Kafka Connect Kafka Connect User Config Ip Filter Object] 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ip_filter_ Sequence[str]strings 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- ip_filters Sequence[str]
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
- kafka_connect GetKafka Connect Kafka Connect User Config Kafka Connect 
- Kafka Connect configuration values
- plugin_versions Sequence[GetKafka Connect Kafka Connect User Config Plugin Version] 
- The plugin selected by the user
- private_access GetKafka Connect Kafka Connect User Config Private Access 
- Allow access to selected service ports from private networks
- privatelink_access GetKafka Connect Kafka Connect User Config Privatelink Access 
- Allow access to selected service components through Privatelink
- public_access GetKafka Connect Kafka Connect User Config Public Access 
- Allow access to selected service ports from the public Internet
- secret_providers Sequence[GetKafka Connect Kafka Connect User Config Secret Provider] 
- 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.
- additionalBackup StringRegions 
- Additional Cloud Regions for Backup Replication.
- ipFilter List<Property Map>Objects 
- Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
- ipFilter List<String>Strings 
- 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.
- 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.
GetKafkaConnectKafkaConnectUserConfigIpFilterObject         
- Network string
- CIDR address block. Example: 10.20.0.0/16.
- Description string
- Description for IP filter list entry. Example: Production service IP range.
- Network string
- CIDR address block. Example: 10.20.0.0/16.
- Description string
- Description for IP filter list entry. Example: Production service IP range.
- network String
- CIDR address block. Example: 10.20.0.0/16.
- description String
- Description for IP filter list entry. Example: Production service IP range.
- network string
- CIDR address block. Example: 10.20.0.0/16.
- description string
- Description for IP filter list entry. Example: Production service IP range.
- network str
- CIDR address block. Example: 10.20.0.0/16.
- description str
- Description for IP filter list entry. Example: Production service IP range.
- network String
- CIDR address block. Example: 10.20.0.0/16.
- description String
- Description for IP filter list entry. Example: Production service IP range.
GetKafkaConnectKafkaConnectUserConfigKafkaConnect        
- ConnectorClient stringConfig Override Policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- ConsumerAuto stringOffset Reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- ConsumerFetch intMax Bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- ConsumerIsolation stringLevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- ConsumerMax intPartition Fetch Bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- ConsumerMax intPoll Interval Ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- ConsumerMax intPoll Records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- OffsetFlush intInterval Ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- OffsetFlush intTimeout Ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- ProducerBatch intSize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- ProducerBuffer intMemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- ProducerCompression stringType 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- ProducerLinger intMs 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- ProducerMax intRequest Size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- ScheduledRebalance intMax Delay Ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- SessionTimeout intMs 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- ConnectorClient stringConfig Override Policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- ConsumerAuto stringOffset Reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- ConsumerFetch intMax Bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- ConsumerIsolation stringLevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- ConsumerMax intPartition Fetch Bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- ConsumerMax intPoll Interval Ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- ConsumerMax intPoll Records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- OffsetFlush intInterval Ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- OffsetFlush intTimeout Ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- ProducerBatch intSize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- ProducerBuffer intMemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- ProducerCompression stringType 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- ProducerLinger intMs 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- ProducerMax intRequest Size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- ScheduledRebalance intMax Delay Ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- SessionTimeout intMs 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connectorClient StringConfig Override Policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- consumerAuto StringOffset Reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- consumerFetch IntegerMax Bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- consumerIsolation StringLevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- consumerMax IntegerPartition Fetch Bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- consumerMax IntegerPoll Interval Ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumerMax IntegerPoll Records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- offsetFlush IntegerInterval Ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- offsetFlush IntegerTimeout Ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producerBatch IntegerSize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- producerBuffer IntegerMemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producerCompression StringType 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- producerLinger IntegerMs 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- producerMax IntegerRequest Size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- scheduledRebalance IntegerMax Delay Ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- sessionTimeout IntegerMs 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connectorClient stringConfig Override Policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- consumerAuto stringOffset Reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- consumerFetch numberMax Bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- consumerIsolation stringLevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- consumerMax numberPartition Fetch Bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- consumerMax numberPoll Interval Ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumerMax numberPoll Records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- offsetFlush numberInterval Ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- offsetFlush numberTimeout Ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producerBatch numberSize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- producerBuffer numberMemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producerCompression stringType 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- producerLinger numberMs 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- producerMax numberRequest Size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- scheduledRebalance numberMax Delay Ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- sessionTimeout numberMs 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connector_client_ strconfig_ override_ policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- consumer_auto_ stroffset_ reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- consumer_fetch_ intmax_ bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- consumer_isolation_ strlevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- consumer_max_ intpartition_ fetch_ bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- consumer_max_ intpoll_ interval_ ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumer_max_ intpoll_ records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- offset_flush_ intinterval_ ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- offset_flush_ inttimeout_ ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producer_batch_ intsize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- producer_buffer_ intmemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producer_compression_ strtype 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- producer_linger_ intms 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- producer_max_ intrequest_ size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- scheduled_rebalance_ intmax_ delay_ ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- session_timeout_ intms 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
- connectorClient StringConfig Override Policy 
- Enum: All,None. Defines what client configurations can be overridden by the connector. Default is None.
- consumerAuto StringOffset Reset 
- Enum: earliest,latest. What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
- consumerFetch NumberMax Bytes 
- Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. Example: 52428800.
- consumerIsolation StringLevel 
- Enum: read_committed,read_uncommitted. Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.
- consumerMax NumberPartition Fetch Bytes 
- Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. Example: 1048576.
- consumerMax NumberPoll Interval Ms 
- The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
- consumerMax NumberPoll Records 
- The maximum number of records returned in a single call to poll() (defaults to 500).
- offsetFlush NumberInterval Ms 
- The interval at which to try committing offsets for tasks (defaults to 60000).
- offsetFlush NumberTimeout Ms 
- Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
- producerBatch NumberSize 
- This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will lingerfor the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
- producerBuffer NumberMemory 
- The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
- producerCompression StringType 
- Enum: gzip,lz4,none,snappy,zstd. Specify the default compression type for producers. This configuration accepts the standard compression codecs (gzip,snappy,lz4,zstd). It additionally acceptsnonewhich is the default and equivalent to no compression.
- producerLinger NumberMs 
- This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will lingerfor the specified time waiting for more records to show up. Defaults to 0.
- producerMax NumberRequest Size 
- This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. Example: 1048576.
- scheduledRebalance NumberMax Delay Ms 
- The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
- sessionTimeout NumberMs 
- The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
GetKafkaConnectKafkaConnectUserConfigPluginVersion        
- PluginName string
- The name of the plugin. Example: debezium-connector.
- Version string
- The version of the plugin. Example: 2.5.0.
- PluginName string
- The name of the plugin. Example: debezium-connector.
- Version string
- The version of the plugin. Example: 2.5.0.
- pluginName String
- The name of the plugin. Example: debezium-connector.
- version String
- The version of the plugin. Example: 2.5.0.
- pluginName string
- The name of the plugin. Example: debezium-connector.
- version string
- The version of the plugin. Example: 2.5.0.
- plugin_name str
- The name of the plugin. Example: debezium-connector.
- version str
- The version of the plugin. Example: 2.5.0.
- pluginName String
- The name of the plugin. Example: debezium-connector.
- version String
- The version of the plugin. Example: 2.5.0.
GetKafkaConnectKafkaConnectUserConfigPrivateAccess        
- 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.
GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess        
- 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.
GetKafkaConnectKafkaConnectUserConfigPublicAccess        
- 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.
GetKafkaConnectKafkaConnectUserConfigSecretProvider        
- Name string
- Name of the secret provider. Used to reference secrets in connector config.
- Aws
GetKafka Connect Kafka Connect User Config Secret Provider Aws 
- AWS secret provider configuration
- Vault
GetKafka Connect Kafka Connect User Config Secret Provider Vault 
- Vault secret provider configuration
- Name string
- Name of the secret provider. Used to reference secrets in connector config.
- Aws
GetKafka Connect Kafka Connect User Config Secret Provider Aws 
- AWS secret provider configuration
- Vault
GetKafka Connect Kafka Connect User Config Secret Provider Vault 
- Vault secret provider configuration
- name String
- Name of the secret provider. Used to reference secrets in connector config.
- aws
GetKafka Connect Kafka Connect User Config Secret Provider Aws 
- AWS secret provider configuration
- vault
GetKafka Connect Kafka Connect User Config Secret Provider Vault 
- Vault secret provider configuration
- name string
- Name of the secret provider. Used to reference secrets in connector config.
- aws
GetKafka Connect Kafka Connect User Config Secret Provider Aws 
- AWS secret provider configuration
- vault
GetKafka Connect Kafka Connect User Config Secret Provider Vault 
- Vault secret provider configuration
- name str
- Name of the secret provider. Used to reference secrets in connector config.
- aws
GetKafka Connect Kafka Connect User Config Secret Provider Aws 
- AWS secret provider configuration
- vault
GetKafka Connect Kafka Connect User Config Secret Provider Vault 
- Vault secret provider configuration
- name String
- Name of the secret provider. Used to reference secrets in connector config.
- aws Property Map
- AWS secret provider configuration
- vault Property Map
- Vault secret provider configuration
GetKafkaConnectKafkaConnectUserConfigSecretProviderAws         
- AuthMethod string
- Enum: credentials. Auth method of the vault secret provider.
- Region 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 string
- Enum: credentials. Auth method of the vault secret provider.
- Region 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 String
- Enum: credentials. Auth method of the vault secret provider.
- region 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 string
- Enum: credentials. Auth method of the vault secret provider.
- region 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 str
- Enum: credentials. Auth method of the vault secret provider.
- region str
- Region used to lookup secrets with AWS SecretManager.
- access_key str
- Access key used to authenticate with aws.
- secret_key str
- Secret key used to authenticate with aws.
- authMethod String
- Enum: credentials. Auth method of the vault secret provider.
- region 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.
GetKafkaConnectKafkaConnectUserConfigSecretProviderVault         
- Address string
- Address of the Vault server.
- AuthMethod 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.
- PrefixPath intDepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- Token string
- Token used to authenticate with vault and auth method token.
- Address string
- Address of the Vault server.
- AuthMethod 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.
- PrefixPath intDepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- Token string
- Token used to authenticate with vault and auth method token.
- address String
- Address of the Vault server.
- authMethod 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.
- prefixPath IntegerDepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token String
- Token used to authenticate with vault and auth method token.
- address string
- Address of the Vault server.
- authMethod 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.
- prefixPath numberDepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token string
- Token used to authenticate with vault and auth method token.
- address str
- Address of the Vault server.
- auth_method str
- Enum: token. Auth method of the vault secret provider.
- engine_version int
- Enum: 1,2, and newer. KV Secrets Engine version of the Vault server instance.
- prefix_path_ intdepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token str
- Token used to authenticate with vault and auth method token.
- address String
- Address of the Vault server.
- authMethod 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.
- prefixPath NumberDepth 
- Prefix path depth of the secrets Engine. Default is 1. If the secrets engine path has more than one segment it has to be increased to the number of segments.
- token String
- Token used to authenticate with vault and auth method token.
GetKafkaConnectServiceIntegration    
- IntegrationType string
- Type of the service integration
- SourceService stringName 
- Name of the source service
- IntegrationType string
- Type of the service integration
- SourceService stringName 
- Name of the source service
- integrationType String
- Type of the service integration
- sourceService StringName 
- Name of the source service
- integrationType string
- Type of the service integration
- sourceService stringName 
- Name of the source service
- integration_type str
- Type of the service integration
- source_service_ strname 
- Name of the source service
- integrationType String
- Type of the service integration
- sourceService StringName 
- Name of the source service
GetKafkaConnectTag   
GetKafkaConnectTechEmail    
- Email string
- An email address to contact for technical issues
- Email string
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
- email string
- An email address to contact for technical issues
- email str
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the aivenTerraform Provider.