Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kafka
  6. User
Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kafka.User

volcenginecc logo
Viewing docs for volcenginecc v0.0.42
published on Thursday, Jun 11, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    SASL user details

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const kafkaUserDemo = new volcenginecc.kafka.User("KafkaUserDemo", {
    instanceId: "kafka-cnngavomxxxxxx",
    userName: "user1123",
    userPassword: "********",
    allAuthority: true,
    description: "vip",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

kafka_user_demo = volcenginecc.kafka.User("KafkaUserDemo",
    instance_id="kafka-cnngavomxxxxxx",
    user_name="user1123",
    user_password="********",
    all_authority=True,
    description="vip")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/kafka"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kafka.NewUser(ctx, "KafkaUserDemo", &kafka.UserArgs{
			InstanceId:   pulumi.String("kafka-cnngavomxxxxxx"),
			UserName:     pulumi.String("user1123"),
			UserPassword: pulumi.String("********"),
			AllAuthority: pulumi.Bool(true),
			Description:  pulumi.String("vip"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var kafkaUserDemo = new Volcenginecc.Kafka.User("KafkaUserDemo", new()
    {
        InstanceId = "kafka-cnngavomxxxxxx",
        UserName = "user1123",
        UserPassword = "********",
        AllAuthority = true,
        Description = "vip",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.kafka.User;
import com.volcengine.volcenginecc.kafka.UserArgs;
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) {
        var kafkaUserDemo = new User("kafkaUserDemo", UserArgs.builder()
            .instanceId("kafka-cnngavomxxxxxx")
            .userName("user1123")
            .userPassword("********")
            .allAuthority(true)
            .description("vip")
            .build());

    }
}

    resources:
  kafkaUserDemo:
    type: volcenginecc:kafka:User
    name: KafkaUserDemo
    properties:
      instanceId: kafka-cnngavomxxxxxx
      userName: user1123
      userPassword: '********'
      allAuthority: true
      description: vip

    Example coming soon!

    Create User Resource

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

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         all_authority: Optional[bool] = None,
         instance_id: Optional[str] = None,
         user_name: Optional[str] = None,
         user_password: Optional[str] = None,
         description: Optional[str] = None,
         password_type: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: volcenginecc:kafka:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_kafka_user" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 exampleuserResourceResourceFromKafkauser = new Volcenginecc.Kafka.User("exampleuserResourceResourceFromKafkauser", new()
{
    AllAuthority = false,
    InstanceId = "string",
    UserName = "string",
    UserPassword = "string",
    Description = "string",
    PasswordType = "string",
});

    example, err := kafka.NewUser(ctx, "exampleuserResourceResourceFromKafkauser", &kafka.UserArgs{
	AllAuthority: pulumi.Bool(false),
	InstanceId:   pulumi.String("string"),
	UserName:     pulumi.String("string"),
	UserPassword: pulumi.String("string"),
	Description:  pulumi.String("string"),
	PasswordType: pulumi.String("string"),
})

    resource "volcenginecc_kafka_user" "exampleuserResourceResourceFromKafkauser" {
  all_authority = false
  instance_id   = "string"
  user_name     = "string"
  user_password = "string"
  description   = "string"
  password_type = "string"
}

    var exampleuserResourceResourceFromKafkauser = new com.volcengine.volcenginecc.kafka.User("exampleuserResourceResourceFromKafkauser", com.volcengine.volcenginecc.kafka.UserArgs.builder()
    .allAuthority(false)
    .instanceId("string")
    .userName("string")
    .userPassword("string")
    .description("string")
    .passwordType("string")
    .build());

    exampleuser_resource_resource_from_kafkauser = volcenginecc.kafka.User("exampleuserResourceResourceFromKafkauser",
    all_authority=False,
    instance_id="string",
    user_name="string",
    user_password="string",
    description="string",
    password_type="string")

    const exampleuserResourceResourceFromKafkauser = new volcenginecc.kafka.User("exampleuserResourceResourceFromKafkauser", {
    allAuthority: false,
    instanceId: "string",
    userName: "string",
    userPassword: "string",
    description: "string",
    passwordType: "string",
});

    type: volcenginecc:kafka:User
properties:
    allAuthority: false
    description: string
    instanceId: string
    passwordType: string
    userName: string
    userPassword: string

    User 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 User resource accepts the following input properties:

    AllAuthority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    InstanceId string
    Instance ID to which the user belongs
    UserName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    UserPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    Description string
    SASL user description
    PasswordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    AllAuthority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    InstanceId string
    Instance ID to which the user belongs
    UserName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    UserPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    Description string
    SASL user description
    PasswordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    all_authority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    instance_id string
    Instance ID to which the user belongs
    user_name string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    user_password string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    description string
    SASL user description
    password_type string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    allAuthority Boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    instanceId String
    Instance ID to which the user belongs
    userName String
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword String
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    description String
    SASL user description
    passwordType String
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    allAuthority boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    instanceId string
    Instance ID to which the user belongs
    userName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    description string
    SASL user description
    passwordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    all_authority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    instance_id str
    Instance ID to which the user belongs
    user_name str
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    user_password str
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    description str
    SASL user description
    password_type str
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    allAuthority Boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    instanceId String
    Instance ID to which the user belongs
    userName String
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword String
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    description String
    SASL user description
    passwordType String
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.

    Outputs

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

    CreateTime string
    SASL user creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    SASL user creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    create_time string
    SASL user creation time
    id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    SASL user creation time
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    SASL user creation time
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    SASL user creation time
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    SASL user creation time
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all_authority: Optional[bool] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        password_type: Optional[str] = None,
        user_name: Optional[str] = None,
        user_password: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:kafka:User    get:      id: ${id}
    import {
  to = volcenginecc_kafka_user.example
  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:
    AllAuthority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    CreateTime string
    SASL user creation time
    Description string
    SASL user description
    InstanceId string
    Instance ID to which the user belongs
    PasswordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    UserName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    UserPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    AllAuthority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    CreateTime string
    SASL user creation time
    Description string
    SASL user description
    InstanceId string
    Instance ID to which the user belongs
    PasswordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    UserName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    UserPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    all_authority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    create_time string
    SASL user creation time
    description string
    SASL user description
    instance_id string
    Instance ID to which the user belongs
    password_type string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    user_name string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    user_password string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    allAuthority Boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    createTime String
    SASL user creation time
    description String
    SASL user description
    instanceId String
    Instance ID to which the user belongs
    passwordType String
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    userName String
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword String
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    allAuthority boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    createTime string
    SASL user creation time
    description string
    SASL user description
    instanceId string
    Instance ID to which the user belongs
    passwordType string
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    userName string
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword string
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    all_authority bool
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    create_time str
    SASL user creation time
    description str
    SASL user description
    instance_id str
    Instance ID to which the user belongs
    password_type str
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    user_name str
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    user_password str
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=
    allAuthority Boolean
    Whether the user has default read and write permissions for all Topics - true: This user has read and write permissions for all Topics - false: This user does not have read and write permissions for all Topics
    createTime String
    SASL user creation time
    description String
    SASL user description
    instanceId String
    Instance ID to which the user belongs
    passwordType String
    SASL user type (password type). Supported types: - Scram: SASL user of SCRAM type - Plain: SASL user of PLAIN type Note: If you create a PLAIN type user, it takes effect after a 1-minute delay. Please wait after creation.
    userName String
    SASL username. Must meet the following requirements: - Consists of letters, numbers, hyphens (-), or underscores (_) - Length: 3–64 characters - Username cannot be set to admin or monitor, and must be unique within the instance
    userPassword String
    SASL user password. Must meet the following requirements: - Length: 8–32 characters - Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters - Supported special characters: !@#$%^&*()_+-=

    Import

    $ pulumi import volcenginecc:kafka/user:User example "instance_id|user_name"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.42
    published on Thursday, Jun 11, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial