Aiven v6.40.0, Jun 24 25

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

aiven.getKafkaConnector

Explore with Pulumi AI

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

Example Usage

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

const kafka_os_connector = aiven.getKafkaConnector({
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
    connectorName: "kafka-opensearch-connector",
});

import pulumi
import pulumi_aiven as aiven

kafka_os_connector = aiven.get_kafka_connector(project=example_project["project"],
    service_name=example_kafka["serviceName"],
    connector_name="kafka-opensearch-connector")

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.LookupKafkaConnector(ctx, &aiven.LookupKafkaConnectorArgs{
			Project:       exampleProject.Project,
			ServiceName:   exampleKafka.ServiceName,
			ConnectorName: "kafka-opensearch-connector",
		}, 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 kafka_os_connector = Aiven.GetKafkaConnector.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
        ConnectorName = "kafka-opensearch-connector",
    });

});

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.GetKafkaConnectorArgs;
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 kafka-os-connector = AivenFunctions.getKafkaConnector(GetKafkaConnectorArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .connectorName("kafka-opensearch-connector")
            .build());

    }
}

variables:
  kafka-os-connector:
    fn::invoke:
      function: aiven:getKafkaConnector
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleKafka.serviceName}
        connectorName: kafka-opensearch-connector

Using getKafkaConnector

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 getKafkaConnector(args: GetKafkaConnectorArgs, opts?: InvokeOptions): Promise<GetKafkaConnectorResult>
function getKafkaConnectorOutput(args: GetKafkaConnectorOutputArgs, opts?: InvokeOptions): Output<GetKafkaConnectorResult>

def get_kafka_connector(connector_name: Optional[str] = None,
                        project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetKafkaConnectorResult
def get_kafka_connector_output(connector_name: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetKafkaConnectorResult]

func LookupKafkaConnector(ctx *Context, args *LookupKafkaConnectorArgs, opts ...InvokeOption) (*LookupKafkaConnectorResult, error)
func LookupKafkaConnectorOutput(ctx *Context, args *LookupKafkaConnectorOutputArgs, opts ...InvokeOption) LookupKafkaConnectorResultOutput

> Note: This function is named LookupKafkaConnector in the Go SDK.

public static class GetKafkaConnector 
{
    public static Task<GetKafkaConnectorResult> InvokeAsync(GetKafkaConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaConnectorResult> Invoke(GetKafkaConnectorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKafkaConnectorResult> getKafkaConnector(GetKafkaConnectorArgs args, InvokeOptions options)
public static Output<GetKafkaConnectorResult> getKafkaConnector(GetKafkaConnectorArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getKafkaConnector:getKafkaConnector
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

ConnectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

connectorName String: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

connectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

connector_name str: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

connectorName String: The Kafka connector name. Changing this property forces recreation of the resource.
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: The name of the service that 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.

getKafkaConnector Result

The following output properties are available:

Config Dictionary<string, string>: The Kafka connector configuration parameters.
ConnectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
Id string: The provider-assigned unique ID for this managed resource.
PluginAuthor string: The Kafka connector author.
PluginClass string: The Kafka connector Java class.
PluginDocUrl string: The Kafka connector documentation URL.
PluginTitle string: The Kafka connector title.
PluginType string: The Kafka connector type.
PluginVersion string: The version of the Kafka connector.
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: The name of the service that 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.
Tasks List<GetKafkaConnectorTask>: List of tasks of a connector.

Config map[string]string: The Kafka connector configuration parameters.
ConnectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
Id string: The provider-assigned unique ID for this managed resource.
PluginAuthor string: The Kafka connector author.
PluginClass string: The Kafka connector Java class.
PluginDocUrl string: The Kafka connector documentation URL.
PluginTitle string: The Kafka connector title.
PluginType string: The Kafka connector type.
PluginVersion string: The version of the Kafka connector.
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: The name of the service that 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.
Tasks []GetKafkaConnectorTask: List of tasks of a connector.

config Map<String,String>: The Kafka connector configuration parameters.
connectorName String: The Kafka connector name. Changing this property forces recreation of the resource.
id String: The provider-assigned unique ID for this managed resource.
pluginAuthor String: The Kafka connector author.
pluginClass String: The Kafka connector Java class.
pluginDocUrl String: The Kafka connector documentation URL.
pluginTitle String: The Kafka connector title.
pluginType String: The Kafka connector type.
pluginVersion String: The version of the Kafka connector.
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: The name of the service that 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.
tasks List<GetKafkaConnectorTask>: List of tasks of a connector.

config {[key: string]: string}: The Kafka connector configuration parameters.
connectorName string: The Kafka connector name. Changing this property forces recreation of the resource.
id string: The provider-assigned unique ID for this managed resource.
pluginAuthor string: The Kafka connector author.
pluginClass string: The Kafka connector Java class.
pluginDocUrl string: The Kafka connector documentation URL.
pluginTitle string: The Kafka connector title.
pluginType string: The Kafka connector type.
pluginVersion string: The version of the Kafka connector.
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: The name of the service that 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.
tasks GetKafkaConnectorTask[]: List of tasks of a connector.

config Mapping[str, str]: The Kafka connector configuration parameters.
connector_name str: The Kafka connector name. Changing this property forces recreation of the resource.
id str: The provider-assigned unique ID for this managed resource.
plugin_author str: The Kafka connector author.
plugin_class str: The Kafka connector Java class.
plugin_doc_url str: The Kafka connector documentation URL.
plugin_title str: The Kafka connector title.
plugin_type str: The Kafka connector type.
plugin_version str: The version of the Kafka connector.
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: The name of the service that 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.
tasks Sequence[GetKafkaConnectorTask]: List of tasks of a connector.

config Map<String>: The Kafka connector configuration parameters.
connectorName String: The Kafka connector name. Changing this property forces recreation of the resource.
id String: The provider-assigned unique ID for this managed resource.
pluginAuthor String: The Kafka connector author.
pluginClass String: The Kafka connector Java class.
pluginDocUrl String: The Kafka connector documentation URL.
pluginTitle String: The Kafka connector title.
pluginType String: The Kafka connector type.
pluginVersion String: The version of the Kafka connector.
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: The name of the service that 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.
tasks List<Property Map>: List of tasks of a connector.

Supporting Types

GetKafkaConnectorTask

Connector string: The name of the related connector.
Task int: The task ID of the task.

Connector string: The name of the related connector.
Task int: The task ID of the task.

connector String: The name of the related connector.
task Integer: The task ID of the task.

connector string: The name of the related connector.
task number: The task ID of the task.

connector str: The name of the related connector.
task int: The task ID of the task.

connector String: The name of the related connector.
task Number: The task ID of the task.

Package Details

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

Aiven v6.40.0 published on Tuesday, Jun 24, 2025 by Pulumi

pulumi/pulumi-aiven

aiven.getKafkaConnector

On this page

On this page

Example Usage

Using getKafkaConnector

getKafkaConnector Result

Supporting Types

GetKafkaConnectorTask

Package Details

On this page

On this page