1. Packages
  2. Aiven
  3. API Docs
  4. getKafkaConnect
Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi

aiven.getKafkaConnect

Explore with Pulumi AI

aiven logo
Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi

    The Kafka Connect data source provides information about the existing Aiven Kafka Connect service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const kc1 = aiven.getKafkaConnect({
        project: data.aiven_project.pr1.project,
        serviceName: "my-kc1",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    kc1 = aiven.get_kafka_connect(project=data["aiven_project"]["pr1"]["project"],
        service_name="my-kc1")
    
    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:     data.Aiven_project.Pr1.Project,
    			ServiceName: "my-kc1",
    		}, 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 kc1 = Aiven.GetKafkaConnect.Invoke(new()
        {
            Project = data.Aiven_project.Pr1.Project,
            ServiceName = "my-kc1",
        });
    
    });
    
    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 kc1 = AivenFunctions.getKafkaConnect(GetKafkaConnectArgs.builder()
                .project(data.aiven_project().pr1().project())
                .serviceName("my-kc1")
                .build());
    
        }
    }
    
    variables:
      kc1:
        fn::invoke:
          Function: aiven:getKafkaConnect
          Arguments:
            project: ${data.aiven_project.pr1.project}
            serviceName: my-kc1
    

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aiven:index/getKafkaConnect:getKafkaConnect
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    Identifies 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
    Identifies 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
    Identifies 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
    Identifies 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
    Identifies 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
    Identifies 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:

    AdditionalDiskSpace string
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    CloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    Components List<GetKafkaConnectComponent>
    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.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaConnectUserConfigs List<GetKafkaConnectKafkaConnectUserConfig>
    KafkaConnect user configurable settings
    KafkaConnects List<GetKafkaConnectKafkaConnect>
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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<GetKafkaConnectServiceIntegration>
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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<GetKafkaConnectTag>
    Tags are key-value pairs that allow you to categorize services.
    TechEmails List<GetKafkaConnectTechEmail>
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    CloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    Components []GetKafkaConnectComponent
    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.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaConnectUserConfigs []GetKafkaConnectKafkaConnectUserConfig
    KafkaConnect user configurable settings
    KafkaConnects []GetKafkaConnectKafkaConnect
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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 []GetKafkaConnectServiceIntegration
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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 []GetKafkaConnectTag
    Tags are key-value pairs that allow you to categorize services.
    TechEmails []GetKafkaConnectTechEmail
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    cloudName String
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components List<GetKafkaConnectComponent>
    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.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaConnectUserConfigs List<GetKafkaConnectKafkaConnectUserConfig>
    KafkaConnect user configurable settings
    kafkaConnects List<GetKafkaConnectKafkaConnect>
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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<GetKafkaConnectServiceIntegration>
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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<GetKafkaConnectTag>
    Tags are key-value pairs that allow you to categorize services.
    techEmails List<GetKafkaConnectTechEmail>
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    cloudName string
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components GetKafkaConnectComponent[]
    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.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    kafkaConnectUserConfigs GetKafkaConnectKafkaConnectUserConfig[]
    KafkaConnect user configurable settings
    kafkaConnects GetKafkaConnectKafkaConnect[]
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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 GetKafkaConnectServiceIntegration[]
    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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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 GetKafkaConnectTag[]
    Tags are key-value pairs that allow you to categorize services.
    techEmails GetKafkaConnectTechEmail[]
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    cloud_name str
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components Sequence[GetKafkaConnectComponent]
    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_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
    id str
    The provider-assigned unique ID for this managed resource.
    kafka_connect_user_configs Sequence[GetKafkaConnectKafkaConnectUserConfig]
    KafkaConnect user configurable settings
    kafka_connects Sequence[GetKafkaConnectKafkaConnect]
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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[GetKafkaConnectServiceIntegration]
    Service integrations to specify when creating a service. Not applied after initial service creation
    service_name str
    Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
    service_password str
    Password used for connecting to the service, if applicable
    service_port int
    The port of the service
    service_type str
    Aiven internal service type code
    service_uri str
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    service_username str
    Username used for connecting to the service, if applicable
    state str
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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[GetKafkaConnectTag]
    Tags are key-value pairs that allow you to categorize services.
    tech_emails Sequence[GetKafkaConnectTechEmail]
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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
    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
    cloudName String
    Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
    components List<Property Map>
    Service component information objects
    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.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaConnectUserConfigs List<Property Map>
    KafkaConnect user configurable settings
    kafkaConnects List<Property Map>
    Kafka Connect server provided values
    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 seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. 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 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
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    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>
    Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.
    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

    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
    KafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    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
    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
    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
    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
    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
    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

    AdditionalBackupRegions string
    Additional Cloud Regions for Backup Replication.

    Deprecated:This property is deprecated.

    IpFilterObjects List<GetKafkaConnectKafkaConnectUserConfigIpFilterObject>
    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 GetKafkaConnectKafkaConnectUserConfigKafkaConnect
    Kafka Connect configuration values
    PrivateAccess GetKafkaConnectKafkaConnectUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    PublicAccess GetKafkaConnectKafkaConnectUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    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 []GetKafkaConnectKafkaConnectUserConfigIpFilterObject
    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 GetKafkaConnectKafkaConnectUserConfigKafkaConnect
    Kafka Connect configuration values
    PrivateAccess GetKafkaConnectKafkaConnectUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    PublicAccess GetKafkaConnectKafkaConnectUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    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<GetKafkaConnectKafkaConnectUserConfigIpFilterObject>
    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 GetKafkaConnectKafkaConnectUserConfigKafkaConnect
    Kafka Connect configuration values
    privateAccess GetKafkaConnectKafkaConnectUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    publicAccess GetKafkaConnectKafkaConnectUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    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 GetKafkaConnectKafkaConnectUserConfigIpFilterObject[]
    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 GetKafkaConnectKafkaConnectUserConfigKafkaConnect
    Kafka Connect configuration values
    privateAccess GetKafkaConnectKafkaConnectUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    publicAccess GetKafkaConnectKafkaConnectUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    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[GetKafkaConnectKafkaConnectUserConfigIpFilterObject]
    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 GetKafkaConnectKafkaConnectUserConfigKafkaConnect
    Kafka Connect configuration values
    private_access GetKafkaConnectKafkaConnectUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelink_access GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    public_access GetKafkaConnectKafkaConnectUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    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
    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
    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.
    Description string
    Description for IP filter list entry.
    Network string
    CIDR address block.
    Description string
    Description for IP filter list entry.
    network String
    CIDR address block.
    description String
    Description for IP filter list entry.
    network string
    CIDR address block.
    description string
    Description for IP filter list entry.
    network str
    CIDR address block.
    description str
    Description for IP filter list entry.
    network String
    CIDR address block.
    description String
    Description for IP filter list entry.

    GetKafkaConnectKafkaConnectUserConfigKafkaConnect

    ConnectorClientConfigOverridePolicy string
    Defines what client configurations can be overridden by the connector. Default is None.
    ConsumerAutoOffsetReset string
    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.
    ConsumerIsolationLevel string
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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
    Defines what client configurations can be overridden by the connector. Default is None.
    ConsumerAutoOffsetReset string
    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.
    ConsumerIsolationLevel string
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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
    Defines what client configurations can be overridden by the connector. Default is None.
    consumerAutoOffsetReset String
    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.
    consumerIsolationLevel String
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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
    Defines what client configurations can be overridden by the connector. Default is None.
    consumerAutoOffsetReset string
    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.
    consumerIsolationLevel string
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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
    Defines what client configurations can be overridden by the connector. Default is None.
    consumer_auto_offset_reset str
    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.
    consumer_isolation_level str
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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
    Defines what client configurations can be overridden by the connector. Default is None.
    consumerAutoOffsetReset String
    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.
    consumerIsolationLevel String
    Transaction read isolation level. read_uncommitted is the default, but read_committed 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. .
    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
    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.
    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).

    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.

    GetKafkaConnectServiceIntegration

    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service
    integrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName string
    Name of the source service
    integration_type str
    Type of the service integration. The only supported value at the moment is read_replica
    source_service_name str
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service

    GetKafkaConnectTag

    Key string
    Service tag key
    Value string
    Service tag value
    Key string
    Service tag key
    Value string
    Service tag value
    key String
    Service tag key
    value String
    Service tag value
    key string
    Service tag key
    value string
    Service tag value
    key str
    Service tag key
    value str
    Service tag value
    key String
    Service tag key
    value String
    Service tag value

    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 aiven Terraform Provider.
    aiven logo
    Aiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi