Class DatabaseUser

Inheritance

System.Object

Resource

CustomResource

DatabaseUser

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Mongodbatlas

Assembly: Pulumi.Mongodbatlas.dll

Syntax

public class DatabaseUser : CustomResource

Constructors

DatabaseUser(String, DatabaseUserArgs, CustomResourceOptions)

Create a DatabaseUser resource with the given unique name, arguments, and options.

Declaration

public DatabaseUser(string name, DatabaseUserArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DatabaseUserArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AuthDatabaseName

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is always the admin database.

Declaration

public Output<string> AuthDatabaseName { get; }

Property Value

Type	Description
Output<System.String>

DatabaseName

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

Labels

Declaration

public Output<ImmutableArray<DatabaseUserLabel>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<DatabaseUserLabel>>

Password

Declaration

public Output<string> Password { get; }

Property Value

Type	Description
Output<System.String>

ProjectId

The unique ID for the project to create the database user.

Declaration

public Output<string> ProjectId { get; }

Property Value

Type	Description
Output<System.String>

Roles

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

Declaration

public Output<ImmutableArray<DatabaseUserRole>> Roles { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<DatabaseUserRole>>

Username

Username for authenticating to MongoDB.

Declaration

public Output<string> Username { get; }

Property Value

Type	Description
Output<System.String>

X509Type

X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE. The accepted types are:

Declaration

public Output<string> X509Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, DatabaseUserState, CustomResourceOptions)

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

Declaration

public static DatabaseUser Get(string name, Input<string> id, DatabaseUserState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DatabaseUserState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
DatabaseUser