Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Redpanda Provider
  3. API Docs
  4. User
redpanda 0.15.1 published on Wednesday, Apr 16, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

redpanda.User

Explore with Pulumi AI

redpanda 0.15.1 published on Wednesday, Apr 16, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

Import

$ pulumi import redpanda:index/user:User example userName,clusterId
Copy

Where clusterId is the ID of the cluster in Redpanda Cloud

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,
         cluster_api_url: Optional[str] = None,
         password: Optional[str] = None,
         mechanism: Optional[str] = None,
         name: 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: redpanda:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 userResource = new Redpanda.User("userResource", new()
{
    ClusterApiUrl = "string",
    Password = "string",
    Mechanism = "string",
    Name = "string",
});
Copy
example, err := redpanda.NewUser(ctx, "userResource", &redpanda.UserArgs{
	ClusterApiUrl: pulumi.String("string"),
	Password:      pulumi.String("string"),
	Mechanism:     pulumi.String("string"),
	Name:          pulumi.String("string"),
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .clusterApiUrl("string")
    .password("string")
    .mechanism("string")
    .name("string")
    .build());
Copy
user_resource = redpanda.User("userResource",
    cluster_api_url="string",
    password="string",
    mechanism="string",
    name="string")
Copy
const userResource = new redpanda.User("userResource", {
    clusterApiUrl: "string",
    password: "string",
    mechanism: "string",
    name: "string",
});
Copy
type: redpanda:User
properties:
    clusterApiUrl: string
    mechanism: string
    name: string
    password: string
Copy

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:

ClusterApiUrl This property is required. string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
Password This property is required. string
Password of the user
Mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
Name string
Name of the user, must be unique
ClusterApiUrl This property is required. string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
Password This property is required. string
Password of the user
Mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
Name string
Name of the user, must be unique
clusterApiUrl This property is required. String
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
password This property is required. String
Password of the user
mechanism String
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name String
Name of the user, must be unique
clusterApiUrl This property is required. string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
password This property is required. string
Password of the user
mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name string
Name of the user, must be unique
cluster_api_url This property is required. str
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
password This property is required. str
Password of the user
mechanism str
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name str
Name of the user, must be unique
clusterApiUrl This property is required. String
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
password This property is required. String
Password of the user
mechanism String
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name String
Name of the user, must be unique

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
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,
        cluster_api_url: Optional[str] = None,
        mechanism: Optional[str] = None,
        name: Optional[str] = None,
        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: redpanda:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClusterApiUrl string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
Mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
Name string
Name of the user, must be unique
Password string
Password of the user
ClusterApiUrl string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
Mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
Name string
Name of the user, must be unique
Password string
Password of the user
clusterApiUrl String
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
mechanism String
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name String
Name of the user, must be unique
password String
Password of the user
clusterApiUrl string
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
mechanism string
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name string
Name of the user, must be unique
password string
Password of the user
cluster_api_url str
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
mechanism str
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name str
Name of the user, must be unique
password str
Password of the user
clusterApiUrl String
The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports
mechanism String
Which authentication method to use, see https://docs.redpanda.com/current/manage/security/authentication/ for more information
name String
Name of the user, must be unique
password String
Password of the user

Package Details

Repository
redpanda redpanda-data/terraform-provider-redpanda
License
Notes
This Pulumi package is based on the redpanda Terraform Provider.
redpanda 0.15.1 published on Wednesday, Apr 16, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda