OVHCloud v2.1.1, Apr 10 25

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

ovh.CloudProjectDatabase.RedisUser

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

Import

OVHcloud Managed Redis 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/redisUser:RedisUser my_user service_name/cluster_id/id

Create RedisUser Resource

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

new RedisUser(name: string, args: RedisUserArgs, opts?: CustomResourceOptions);

@overload
def RedisUser(resource_name: str,
              args: RedisUserArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def RedisUser(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cluster_id: Optional[str] = None,
              service_name: Optional[str] = None,
              categories: Optional[Sequence[str]] = None,
              channels: Optional[Sequence[str]] = None,
              commands: Optional[Sequence[str]] = None,
              keys: Optional[Sequence[str]] = None,
              name: Optional[str] = None,
              password_reset: Optional[str] = None)

func NewRedisUser(ctx *Context, name string, args RedisUserArgs, opts ...ResourceOption) (*RedisUser, error)

public RedisUser(string name, RedisUserArgs args, CustomResourceOptions? opts = null)

public RedisUser(String name, RedisUserArgs args)
public RedisUser(String name, RedisUserArgs args, CustomResourceOptions options)

type: ovh:CloudProjectDatabase:RedisUser
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 RedisUserArgs: 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 RedisUserArgs: 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 RedisUserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RedisUserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RedisUserArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var redisUserResource = new Ovh.CloudProjectDatabase.RedisUser("redisUserResource", new()
{
    ClusterId = "string",
    ServiceName = "string",
    Categories = new[]
    {
        "string",
    },
    Channels = new[]
    {
        "string",
    },
    Commands = new[]
    {
        "string",
    },
    Keys = new[]
    {
        "string",
    },
    Name = "string",
    PasswordReset = "string",
});

example, err := CloudProjectDatabase.NewRedisUser(ctx, "redisUserResource", &CloudProjectDatabase.RedisUserArgs{
	ClusterId:   pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Categories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Channels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Commands: pulumi.StringArray{
		pulumi.String("string"),
	},
	Keys: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:          pulumi.String("string"),
	PasswordReset: pulumi.String("string"),
})

var redisUserResource = new RedisUser("redisUserResource", RedisUserArgs.builder()
    .clusterId("string")
    .serviceName("string")
    .categories("string")
    .channels("string")
    .commands("string")
    .keys("string")
    .name("string")
    .passwordReset("string")
    .build());

redis_user_resource = ovh.cloud_project_database.RedisUser("redisUserResource",
    cluster_id="string",
    service_name="string",
    categories=["string"],
    channels=["string"],
    commands=["string"],
    keys=["string"],
    name="string",
    password_reset="string")

const redisUserResource = new ovh.cloudprojectdatabase.RedisUser("redisUserResource", {
    clusterId: "string",
    serviceName: "string",
    categories: ["string"],
    channels: ["string"],
    commands: ["string"],
    keys: ["string"],
    name: "string",
    passwordReset: "string",
});

type: ovh:CloudProjectDatabase:RedisUser
properties:
    categories:
        - string
    channels:
        - string
    clusterId: string
    commands:
        - string
    keys:
        - string
    name: string
    passwordReset: string
    serviceName: string

RedisUser 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 RedisUser 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.
Categories List<string>: Categories of the user.
Channels List<string>: Channels of the user.
Commands List<string>: Commands of the user.
Keys List<string>: Keys of the user.
Name string: Name of the 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.
Categories []string: Categories of the user.
Channels []string: Channels of the user.
Commands []string: Commands of the user.
Keys []string: Keys of the user.
Name string: Name of the 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.
categories List<String>: Categories of the user.
channels List<String>: Channels of the user.
commands List<String>: Commands of the user.
keys List<String>: Keys of the user.
name String: Name of the 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.
categories string[]: Categories of the user.
channels string[]: Channels of the user.
commands string[]: Commands of the user.
keys string[]: Keys of the user.
name string: Name of the 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.
categories Sequence[str]: Categories of the user.
channels Sequence[str]: Channels of the user.
commands Sequence[str]: Commands of the user.
keys Sequence[str]: Keys of the user.
name str: Name of the 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.
categories List<String>: Categories of the user.
channels List<String>: Channels of the user.
commands List<String>: Commands of the user.
keys List<String>: Keys of the user.
name String: Name of the user.
passwordReset String: Arbitrary string to change to trigger a password update

Outputs

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

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: RedisUserState, opts?: CustomResourceOptions): RedisUser

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        categories: Optional[Sequence[str]] = None,
        channels: Optional[Sequence[str]] = None,
        cluster_id: Optional[str] = None,
        commands: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        keys: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_reset: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None) -> RedisUser

func GetRedisUser(ctx *Context, name string, id IDInput, state *RedisUserState, opts ...ResourceOption) (*RedisUser, error)

public static RedisUser Get(string name, Input<string> id, RedisUserState? state, CustomResourceOptions? opts = null)

public static RedisUser get(String name, Output<String> id, RedisUserState state, CustomResourceOptions options)

resources:  _:    type: ovh:CloudProjectDatabase:RedisUser    get:      id: ${id}

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:

Categories List<string>: Categories of the user.
Channels List<string>: Channels of the user.
ClusterId string: Cluster ID.
Commands List<string>: Commands of the user.
CreatedAt string: Date of the creation of the user.
Keys List<string>: Keys of the user.
Name string: Name of the 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.

Categories []string: Categories of the user.
Channels []string: Channels of the user.
ClusterId string: Cluster ID.
Commands []string: Commands of the user.
CreatedAt string: Date of the creation of the user.
Keys []string: Keys of the user.
Name string: Name of the 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.

categories List<String>: Categories of the user.
channels List<String>: Channels of the user.
clusterId String: Cluster ID.
commands List<String>: Commands of the user.
createdAt String: Date of the creation of the user.
keys List<String>: Keys of the user.
name String: Name of the 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.

categories string[]: Categories of the user.
channels string[]: Channels of the user.
clusterId string: Cluster ID.
commands string[]: Commands of the user.
createdAt string: Date of the creation of the user.
keys string[]: Keys of the user.
name string: Name of the 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.

categories Sequence[str]: Categories of the user.
channels Sequence[str]: Channels of the user.
cluster_id str: Cluster ID.
commands Sequence[str]: Commands of the user.
created_at str: Date of the creation of the user.
keys Sequence[str]: Keys of the user.
name str: Name of the 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.

categories List<String>: Categories of the user.
channels List<String>: Channels of the user.
clusterId String: Cluster ID.
commands List<String>: Commands of the user.
createdAt String: Date of the creation of the user.
keys List<String>: Keys of the user.
name String: Name of the 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.

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

ovh/pulumi-ovh

ovh.CloudProjectDatabase.RedisUser

On this page

On this page

Import

Create RedisUser Resource

Constructor syntax

Parameters

Constructor example

RedisUser Resource Properties

Inputs

Outputs

Look up Existing RedisUser Resource

Package Details

On this page

On this page