Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. getRedisUser
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.getRedisUser

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

Use this data source to get information about a user of a redis cluster associated with a public cloud project.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@pulumi/ovh";

const redisUser = ovh.CloudProject.getRedisUser({
    serviceName: "XXX",
    clusterId: "YYY",
    name: "ZZZ",
});
export const redisUserCommands = redisUser.then(redisUser => redisUser.commands);
Copy
import pulumi
import pulumi_ovh as ovh

redis_user = ovh.CloudProject.get_redis_user(service_name="XXX",
    cluster_id="YYY",
    name="ZZZ")
pulumi.export("redisUserCommands", redis_user.commands)
Copy
package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		redisUser, err := cloudproject.GetRedisUser(ctx, &cloudproject.GetRedisUserArgs{
			ServiceName: "XXX",
			ClusterId:   "YYY",
			Name:        "ZZZ",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("redisUserCommands", redisUser.Commands)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var redisUser = Ovh.CloudProject.GetRedisUser.Invoke(new()
    {
        ServiceName = "XXX",
        ClusterId = "YYY",
        Name = "ZZZ",
    });

    return new Dictionary<string, object?>
    {
        ["redisUserCommands"] = redisUser.Apply(getRedisUserResult => getRedisUserResult.Commands),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetRedisUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var redisUser = CloudProjectFunctions.getRedisUser(GetRedisUserArgs.builder()
            .serviceName("XXX")
            .clusterId("YYY")
            .name("ZZZ")
            .build());

        ctx.export("redisUserCommands", redisUser.commands());
    }
}
Copy
variables:
  redisUser:
    fn::invoke:
      function: ovh:CloudProject:getRedisUser
      arguments:
        serviceName: XXX
        clusterId: YYY
        name: ZZZ
outputs:
  redisUserCommands: ${redisUser.commands}
Copy

Using getRedisUser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRedisUser(args: GetRedisUserArgs, opts?: InvokeOptions): Promise<GetRedisUserResult>
function getRedisUserOutput(args: GetRedisUserOutputArgs, opts?: InvokeOptions): Output<GetRedisUserResult>
Copy
def get_redis_user(cluster_id: Optional[str] = None,
                   name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRedisUserResult
def get_redis_user_output(cluster_id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRedisUserResult]
Copy
func GetRedisUser(ctx *Context, args *GetRedisUserArgs, opts ...InvokeOption) (*GetRedisUserResult, error)
func GetRedisUserOutput(ctx *Context, args *GetRedisUserOutputArgs, opts ...InvokeOption) GetRedisUserResultOutput
Copy

> Note: This function is named GetRedisUser in the Go SDK.

public static class GetRedisUser 
{
    public static Task<GetRedisUserResult> InvokeAsync(GetRedisUserArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisUserResult> Invoke(GetRedisUserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedisUserResult> getRedisUser(GetRedisUserArgs args, InvokeOptions options)
public static Output<GetRedisUserResult> getRedisUser(GetRedisUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ovh:CloudProject/getRedisUser:getRedisUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterId This property is required. string
Cluster ID
Name This property is required. string
Name of the user
ServiceName This property is required. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
ClusterId This property is required. string
Cluster ID
Name This property is required. string
Name of the user
ServiceName This property is required. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
clusterId This property is required. String
Cluster ID
name This property is required. String
Name of the user
serviceName This property is required. String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
clusterId This property is required. string
Cluster ID
name This property is required. string
Name of the user
serviceName This property is required. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
cluster_id This property is required. str
Cluster ID
name This property is required. str
Name of the user
service_name This property is required. str
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
clusterId This property is required. String
Cluster ID
name This property is required. String
Name of the user
serviceName This property is required. String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

getRedisUser Result

The following output properties are available:

Categories List<string>
Categories of the user.
Channels List<string>
Channels of the user.
ClusterId string
See Argument Reference above.
Commands List<string>
Commands of the user.
CreatedAt string
Date of the creation of the user.
Id string
The provider-assigned unique ID for this managed resource.
Keys List<string>
Keys of the user.
Name string
See Argument Reference above.
ServiceName string
Current status of the user.
Status string
Current status of the user.
Categories []string
Categories of the user.
Channels []string
Channels of the user.
ClusterId string
See Argument Reference above.
Commands []string
Commands of the user.
CreatedAt string
Date of the creation of the user.
Id string
The provider-assigned unique ID for this managed resource.
Keys []string
Keys of the user.
Name string
See Argument Reference above.
ServiceName string
Current status of the user.
Status string
Current status of the user.
categories List<String>
Categories of the user.
channels List<String>
Channels of the user.
clusterId String
See Argument Reference above.
commands List<String>
Commands of the user.
createdAt String
Date of the creation of the user.
id String
The provider-assigned unique ID for this managed resource.
keys List<String>
Keys of the user.
name String
See Argument Reference above.
serviceName String
Current status of the user.
status String
Current status of the user.
categories string[]
Categories of the user.
channels string[]
Channels of the user.
clusterId string
See Argument Reference above.
commands string[]
Commands of the user.
createdAt string
Date of the creation of the user.
id string
The provider-assigned unique ID for this managed resource.
keys string[]
Keys of the user.
name string
See Argument Reference above.
serviceName string
Current status of the user.
status string
Current status of the user.
categories Sequence[str]
Categories of the user.
channels Sequence[str]
Channels of the user.
cluster_id str
See Argument Reference above.
commands Sequence[str]
Commands of the user.
created_at str
Date of the creation of the user.
id str
The provider-assigned unique ID for this managed resource.
keys Sequence[str]
Keys of the user.
name str
See Argument Reference above.
service_name str
Current status of the user.
status str
Current status of the user.
categories List<String>
Categories of the user.
channels List<String>
Channels of the user.
clusterId String
See Argument Reference above.
commands List<String>
Commands of the user.
createdAt String
Date of the creation of the user.
id String
The provider-assigned unique ID for this managed resource.
keys List<String>
Keys of the user.
name String
See Argument Reference above.
serviceName String
Current status of the user.
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