Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. MongoDbUser
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProjectDatabase.MongoDbUser

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

    Import

    OVHcloud Managed MongoDB clusters users can be imported using the service_name, cluster_id and id of the user, separated by “/” E.g.,

    bash

    $ pulumi import ovh:CloudProjectDatabase/mongoDbUser:MongoDbUser my_user service_name/cluster_id/id

    Create MongoDbUser Resource

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

    Constructor syntax

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

@overload
def MongoDbUser(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_id: Optional[str] = None,
                service_name: Optional[str] = None,
                name: Optional[str] = None,
                password_reset: Optional[str] = None,
                roles: Optional[Sequence[str]] = None)
    func NewMongoDbUser(ctx *Context, name string, args MongoDbUserArgs, opts ...ResourceOption) (*MongoDbUser, error)
    public MongoDbUser(string name, MongoDbUserArgs args, CustomResourceOptions? opts = null)
    public MongoDbUser(String name, MongoDbUserArgs args)
public MongoDbUser(String name, MongoDbUserArgs args, CustomResourceOptions options)

    type: ovh:CloudProjectDatabase:MongoDbUser
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 MongoDbUserArgs
    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 MongoDbUserArgs
    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 MongoDbUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoDbUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoDbUserArgs
    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 mongoDbUserResource = new Ovh.CloudProjectDatabase.MongoDbUser("mongoDbUserResource", new()
{
    ClusterId = "string",
    ServiceName = "string",
    Name = "string",
    PasswordReset = "string",
    Roles = new[]
    {
        "string",
    },
});

    example, err := CloudProjectDatabase.NewMongoDbUser(ctx, "mongoDbUserResource", &CloudProjectDatabase.MongoDbUserArgs{
	ClusterId:     pulumi.String("string"),
	ServiceName:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	PasswordReset: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var mongoDbUserResource = new MongoDbUser("mongoDbUserResource", MongoDbUserArgs.builder()
    .clusterId("string")
    .serviceName("string")
    .name("string")
    .passwordReset("string")
    .roles("string")
    .build());

    mongo_db_user_resource = ovh.cloud_project_database.MongoDbUser("mongoDbUserResource",
    cluster_id="string",
    service_name="string",
    name="string",
    password_reset="string",
    roles=["string"])

    const mongoDbUserResource = new ovh.cloudprojectdatabase.MongoDbUser("mongoDbUserResource", {
    clusterId: "string",
    serviceName: "string",
    name: "string",
    passwordReset: "string",
    roles: ["string"],
});

    type: ovh:CloudProjectDatabase:MongoDbUser
properties:
    clusterId: string
    name: string
    passwordReset: string
    roles:
        - string
    serviceName: string

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

    ClusterId string
    Cluster ID.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles List<string>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    ClusterId string
    Cluster ID.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles []string
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    name String
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    clusterId string
    Cluster ID.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    roles string[]
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    cluster_id str
    Cluster ID.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    name str
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    password_reset str
    Arbitrary string to change to trigger a password update
    roles Sequence[str]
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    name String
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin

    Outputs

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

    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Status string
    Current status of the user.
    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Status string
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    status String
    Current status of the user.
    createdAt string
    Date of the creation of the user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (Sensitive) Password of the user.
    status string
    Current status of the user.
    created_at str
    Date of the creation of the user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (Sensitive) Password of the user.
    status str
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    status String
    Current status of the user.

    Look up Existing MongoDbUser Resource

    Get an existing MongoDbUser 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?: MongoDbUserState, opts?: CustomResourceOptions): MongoDbUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        created_at: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_reset: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None) -> MongoDbUser
    func GetMongoDbUser(ctx *Context, name string, id IDInput, state *MongoDbUserState, opts ...ResourceOption) (*MongoDbUser, error)
    public static MongoDbUser Get(string name, Input<string> id, MongoDbUserState? state, CustomResourceOptions? opts = null)
    public static MongoDbUser get(String name, Output<String> id, MongoDbUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles List<string>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    Roles []string
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.
    clusterId string
    Cluster ID.
    createdAt string
    Date of the creation of the user.
    name string
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    password string
    (Sensitive) Password of the user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    roles string[]
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status string
    Current status of the user.
    cluster_id str
    Cluster ID.
    created_at str
    Date of the creation of the user.
    name str
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    password str
    (Sensitive) Password of the user.
    password_reset str
    Arbitrary string to change to trigger a password update
    roles Sequence[str]
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status str
    Current status of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Name of the user. A user named "admin" is mapped with already created admin@admin user instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    roles List<String>
    Roles the user belongs to. Since version 0.37.0, the authentication database must be indicated for all roles Available roles:

    • backup@admin
    • clusterAdmin@admin
    • clusterManager@admin
    • clusterMonitor@admin
    • dbAdmin@(defined db)
    • dbAdminAnyDatabase@admin
    • dbOwner@(defined db)
    • enableSharding@(defined db)
    • hostManager@admin
    • read@(defined db)
    • readAnyDatabase@admin
    • readWrite@(defined db)
    • readWriteAnyDatabase@admin
    • restore@admin
    • root@admin
    • userAdmin@(defined db)
    • userAdminAnyDatabase@admin
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
    ovh/pulumi-ovh