1. Packages
  2. Aiven Provider
  3. API Docs
  4. getKafkaUser
Viewing docs for Aiven v6.50.0
published on Friday, Feb 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.getKafkaUser

aiven logo
Viewing docs for Aiven v6.50.0
published on Friday, Feb 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Gets information about an Aiven for Apache Kafka® service user.

    Example Usage

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

const exampleServiceUser = aiven.getKafkaUser({
    serviceName: exampleKafka.serviceName,
    project: exampleProject.project,
    username: "example-kafka-user",
});

    import pulumi
import pulumi_aiven as aiven

example_service_user = aiven.get_kafka_user(service_name=example_kafka["serviceName"],
    project=example_project["project"],
    username="example-kafka-user")

    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.LookupKafkaUser(ctx, &aiven.LookupKafkaUserArgs{
			ServiceName: exampleKafka.ServiceName,
			Project:     exampleProject.Project,
			Username:    "example-kafka-user",
		}, 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 exampleServiceUser = Aiven.GetKafkaUser.Invoke(new()
    {
        ServiceName = exampleKafka.ServiceName,
        Project = exampleProject.Project,
        Username = "example-kafka-user",
    });

});

    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.GetKafkaUserArgs;
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 exampleServiceUser = AivenFunctions.getKafkaUser(GetKafkaUserArgs.builder()
            .serviceName(exampleKafka.serviceName())
            .project(exampleProject.project())
            .username("example-kafka-user")
            .build());

    }
}

    variables:
  exampleServiceUser:
    fn::invoke:
      function: aiven:getKafkaUser
      arguments:
        serviceName: ${exampleKafka.serviceName}
        project: ${exampleProject.project}
        username: example-kafka-user

    Using getKafkaUser

    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 getKafkaUser(args: GetKafkaUserArgs, opts?: InvokeOptions): Promise<GetKafkaUserResult>
function getKafkaUserOutput(args: GetKafkaUserOutputArgs, opts?: InvokeOptions): Output<GetKafkaUserResult>
    def get_kafka_user(project: Optional[str] = None,
                   service_name: Optional[str] = None,
                   username: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKafkaUserResult
def get_kafka_user_output(project: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   username: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKafkaUserResult]
    func LookupKafkaUser(ctx *Context, args *LookupKafkaUserArgs, opts ...InvokeOption) (*LookupKafkaUserResult, error)
func LookupKafkaUserOutput(ctx *Context, args *LookupKafkaUserOutputArgs, opts ...InvokeOption) LookupKafkaUserResultOutput

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

    public static class GetKafkaUser 
{
    public static Task<GetKafkaUserResult> InvokeAsync(GetKafkaUserArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaUserResult> Invoke(GetKafkaUserInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKafkaUserResult> getKafkaUser(GetKafkaUserArgs args, InvokeOptions options)
public static Output<GetKafkaUserResult> getKafkaUser(GetKafkaUserArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    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.
    Username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. 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.
    Username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. 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.
    username String
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. 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.
    username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. 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.
    username str
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. 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.
    username String
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    getKafkaUser Result

    The following output properties are available:

    AccessCert string
    Access certificate for the user.
    AccessKey string
    Access certificate key for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    Type string
    User account type, such as primary or regular account.
    Username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    AccessCert string
    Access certificate for the user.
    AccessKey string
    Access certificate key for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    Type string
    User account type, such as primary or regular account.
    Username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    Access certificate for the user.
    accessKey String
    Access certificate key for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    type String
    User account type, such as primary or regular account.
    username String
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert string
    Access certificate for the user.
    accessKey string
    Access certificate key for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    type string
    User account type, such as primary or regular account.
    username string
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    access_cert str
    Access certificate for the user.
    access_key str
    Access certificate key for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    type str
    User account type, such as primary or regular account.
    username str
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    Access certificate for the user.
    accessKey String
    Access certificate key for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the service user (auto-generated if not provided). Must be 8-256 characters if specified.
    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.
    type String
    User account type, such as primary or regular account.
    username String
    Name of the Kafka service user. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.50.0
    published on Friday, Feb 27, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.