1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. User
OVHCloud v0.50.1 published on Friday, Sep 27, 2024 by OVHcloud

ovh.CloudProjectDatabase.User

Explore with Pulumi AI

ovh logo
OVHCloud v0.50.1 published on Friday, Sep 27, 2024 by OVHcloud

    Import

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

    bash

    $ pulumi import ovh:CloudProjectDatabase/user:User my_user service_name/engine/cluster_id/id
    

    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_id: Optional[str] = None,
             engine: Optional[str] = None,
             service_name: Optional[str] = None,
             name: Optional[str] = None,
             password_reset: 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: ovh:CloudProjectDatabase:User
    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 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 ovhUserResource = new Ovh.CloudProjectDatabase.User("ovhUserResource", new()
    {
        ClusterId = "string",
        Engine = "string",
        ServiceName = "string",
        Name = "string",
        PasswordReset = "string",
    });
    
    example, err := CloudProjectDatabase.NewUser(ctx, "ovhUserResource", &CloudProjectDatabase.UserArgs{
    	ClusterId:     pulumi.String("string"),
    	Engine:        pulumi.String("string"),
    	ServiceName:   pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	PasswordReset: pulumi.String("string"),
    })
    
    var ovhUserResource = new User("ovhUserResource", UserArgs.builder()
        .clusterId("string")
        .engine("string")
        .serviceName("string")
        .name("string")
        .passwordReset("string")
        .build());
    
    ovh_user_resource = ovh.cloud_project_database.User("ovhUserResource",
        cluster_id="string",
        engine="string",
        service_name="string",
        name="string",
        password_reset="string")
    
    const ovhUserResource = new ovh.cloudprojectdatabase.User("ovhUserResource", {
        clusterId: "string",
        engine: "string",
        serviceName: "string",
        name: "string",
        passwordReset: "string",
    });
    
    type: ovh:CloudProjectDatabase:User
    properties:
        clusterId: string
        engine: string
        name: string
        passwordReset: string
        serviceName: 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

    The User resource accepts the following input properties:

    ClusterId string
    Cluster ID.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ClusterId string
    Cluster ID.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    passwordReset String
    Arbitrary string to change to trigger a password update
    clusterId string
    Cluster ID.
    engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    passwordReset string
    Arbitrary string to change to trigger a password update
    cluster_id str
    Cluster ID.
    engine str
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    password_reset str
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    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 "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    passwordReset String
    Arbitrary string to change to trigger a password update

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User 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 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_id: Optional[str] = None,
            created_at: Optional[str] = None,
            engine: 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) -> 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)
    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.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    Name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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.
    engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    name string
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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.
    engine str
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    name str
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    name String
    Name of the user. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user. The "Grafana" engine only allows the "avnadmin" mapping.
    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 v0.50.1 published on Friday, Sep 27, 2024 by OVHcloud