KafkaUser

Aiven v5.6.0 (5.x), Mar 9 26

Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v5.6.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Create KafkaUser Resource

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

Constructor syntax

new KafkaUser(name: string, args: KafkaUserArgs, opts?: CustomResourceOptions);

@overload
def KafkaUser(resource_name: str,
              args: KafkaUserArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def KafkaUser(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              project: Optional[str] = None,
              service_name: Optional[str] = None,
              username: Optional[str] = None,
              password: Optional[str] = None)

func NewKafkaUser(ctx *Context, name string, args KafkaUserArgs, opts ...ResourceOption) (*KafkaUser, error)

public KafkaUser(string name, KafkaUserArgs args, CustomResourceOptions? opts = null)

public KafkaUser(String name, KafkaUserArgs args)
public KafkaUser(String name, KafkaUserArgs args, CustomResourceOptions options)

type: aiven:KafkaUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KafkaUserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args KafkaUserArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KafkaUserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KafkaUserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args KafkaUserArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var kafkaUserResource = new Aiven.KafkaUser("kafkaUserResource", new()
{
    Project = "string",
    ServiceName = "string",
    Username = "string",
    Password = "string",
});

example, err := aiven.NewKafkaUser(ctx, "kafkaUserResource", &aiven.KafkaUserArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Username:    pulumi.String("string"),
	Password:    pulumi.String("string"),
})

var kafkaUserResource = new KafkaUser("kafkaUserResource", KafkaUserArgs.builder()
    .project("string")
    .serviceName("string")
    .username("string")
    .password("string")
    .build());

kafka_user_resource = aiven.KafkaUser("kafkaUserResource",
    project="string",
    service_name="string",
    username="string",
    password="string")

const kafkaUserResource = new aiven.KafkaUser("kafkaUserResource", {
    project: "string",
    serviceName: "string",
    username: "string",
    password: "string",
});

type: aiven:KafkaUser
properties:
    password: string
    project: string
    serviceName: string
    username: string

KafkaUser Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The KafkaUser resource accepts the following input properties:

Project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
ServiceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Password string: The password of the Kafka User.

Project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
ServiceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Password string: The password of the Kafka User.

project String: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName String: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
username String: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
password String: The password of the Kafka User.

project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
password string: The password of the Kafka User.

project str: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
service_name str: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
username str: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
password str: The password of the Kafka User.

project String: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName String: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
username String: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
password String: The password of the Kafka User.

Outputs

All input properties are implicitly available as output properties. Additionally, the KafkaUser resource produces the following output properties:

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.
Type string: Type of the user account. Tells whether the user is the primary account or a regular account.

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.
Type string: Type of the user account. Tells whether the user is the primary account or a regular account.

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.
type String: Type of the user account. Tells whether the user is the primary account or a regular account.

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.
type string: Type of the user account. Tells whether the user is the primary account or a regular account.

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.
type str: Type of the user account. Tells whether the user is the primary account or a regular account.

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.
type String: Type of the user account. Tells whether the user is the primary account or a regular account.

Look up Existing KafkaUser Resource

Get an existing KafkaUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KafkaUserState, opts?: CustomResourceOptions): KafkaUser

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_cert: Optional[str] = None,
        access_key: Optional[str] = None,
        password: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None) -> KafkaUser

func GetKafkaUser(ctx *Context, name string, id IDInput, state *KafkaUserState, opts ...ResourceOption) (*KafkaUser, error)

public static KafkaUser Get(string name, Input<string> id, KafkaUserState? state, CustomResourceOptions? opts = null)

public static KafkaUser get(String name, Output<String> id, KafkaUserState state, CustomResourceOptions options)

resources:  _:    type: aiven:KafkaUser    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessCert string: Access certificate for the user
AccessKey string: Access certificate key for the user
Password string: The password of the Kafka User.
Project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
ServiceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Type string: Type of the user account. Tells whether the user is the primary account or a regular account.
Username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

AccessCert string: Access certificate for the user
AccessKey string: Access certificate key for the user
Password string: The password of the Kafka User.
Project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
ServiceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
Type string: Type of the user account. Tells whether the user is the primary account or a regular account.
Username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

accessCert String: Access certificate for the user
accessKey String: Access certificate key for the user
password String: The password of the Kafka User.
project String: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName String: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
type String: Type of the user account. Tells whether the user is the primary account or a regular account.
username String: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

accessCert string: Access certificate for the user
accessKey string: Access certificate key for the user
password string: The password of the Kafka User.
project string: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName string: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
type string: Type of the user account. Tells whether the user is the primary account or a regular account.
username string: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

access_cert str: Access certificate for the user
access_key str: Access certificate key for the user
password str: The password of the Kafka User.
project str: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
service_name str: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
type str: Type of the user account. Tells whether the user is the primary account or a regular account.
username str: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

accessCert String: Access certificate for the user
accessKey String: Access certificate key for the user
password String: The password of the Kafka User.
project String: Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
serviceName String: Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
type String: Type of the user account. Tells whether the user is the primary account or a regular account.
username String: The actual name of the Kafka User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.