1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. M3DbUser
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

ovh.CloudProjectDatabase.M3DbUser

Explore with Pulumi AI

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

    Import

    OVHcloud Managed M3DB 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/m3DbUser:M3DbUser my_user service_name/cluster_id/id
    

    Create M3DbUser Resource

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

    Constructor syntax

    new M3DbUser(name: string, args: M3DbUserArgs, opts?: CustomResourceOptions);
    @overload
    def M3DbUser(resource_name: str,
                 args: M3DbUserArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def M3DbUser(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_id: Optional[str] = None,
                 service_name: Optional[str] = None,
                 group: Optional[str] = None,
                 name: Optional[str] = None,
                 password_reset: Optional[str] = None)
    func NewM3DbUser(ctx *Context, name string, args M3DbUserArgs, opts ...ResourceOption) (*M3DbUser, error)
    public M3DbUser(string name, M3DbUserArgs args, CustomResourceOptions? opts = null)
    public M3DbUser(String name, M3DbUserArgs args)
    public M3DbUser(String name, M3DbUserArgs args, CustomResourceOptions options)
    
    type: ovh:CloudProjectDatabase:M3DbUser
    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 M3DbUserArgs
    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 M3DbUserArgs
    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 M3DbUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args M3DbUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args M3DbUserArgs
    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 m3dbUserResource = new Ovh.CloudProjectDatabase.M3DbUser("m3dbUserResource", new()
    {
        ClusterId = "string",
        ServiceName = "string",
        Group = "string",
        Name = "string",
        PasswordReset = "string",
    });
    
    example, err := CloudProjectDatabase.NewM3DbUser(ctx, "m3dbUserResource", &CloudProjectDatabase.M3DbUserArgs{
    	ClusterId:     pulumi.String("string"),
    	ServiceName:   pulumi.String("string"),
    	Group:         pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	PasswordReset: pulumi.String("string"),
    })
    
    var m3dbUserResource = new M3DbUser("m3dbUserResource", M3DbUserArgs.builder()
        .clusterId("string")
        .serviceName("string")
        .group("string")
        .name("string")
        .passwordReset("string")
        .build());
    
    m3db_user_resource = ovh.cloud_project_database.M3DbUser("m3dbUserResource",
        cluster_id="string",
        service_name="string",
        group="string",
        name="string",
        password_reset="string")
    
    const m3dbUserResource = new ovh.cloudprojectdatabase.M3DbUser("m3dbUserResource", {
        clusterId: "string",
        serviceName: "string",
        group: "string",
        name: "string",
        passwordReset: "string",
    });
    
    type: ovh:CloudProjectDatabase:M3DbUser
    properties:
        clusterId: string
        group: string
        name: string
        passwordReset: string
        serviceName: string
    

    M3DbUser 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 M3DbUser 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.
    Group string
    Group of the user:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ClusterId string
    Cluster ID.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Group string
    Group of the user:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    group String
    Group of the user:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    clusterId string
    Cluster ID.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    group string
    Group of the user:
    name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    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.
    group str
    Group of the user:
    name str
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    password_reset str
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    group String
    Group of the user:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update

    Outputs

    All input properties are implicitly available as output properties. Additionally, the M3DbUser 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 M3DbUser Resource

    Get an existing M3DbUser 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?: M3DbUserState, opts?: CustomResourceOptions): M3DbUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            created_at: Optional[str] = None,
            group: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            password_reset: Optional[str] = None,
            service_name: Optional[str] = None,
            status: Optional[str] = None) -> M3DbUser
    func GetM3DbUser(ctx *Context, name string, id IDInput, state *M3DbUserState, opts ...ResourceOption) (*M3DbUser, error)
    public static M3DbUser Get(string name, Input<string> id, M3DbUserState? state, CustomResourceOptions? opts = null)
    public static M3DbUser get(String name, Output<String> id, M3DbUserState 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.
    Group string
    Group of the user:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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.
    Group string
    Group of the user:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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.
    group String
    Group of the user:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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.
    group string
    Group of the user:
    name string
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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.
    group str
    Group of the user:
    name str
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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.
    group String
    Group of the user:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created 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
    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