Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getRedisUser
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getRedisUser

Explore with Pulumi AI

Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

The Redis User data source provides information about the existing Aiven Redis User.

!> End of life notice In March 2024, a new licensing model was announced for Redis® that impacts the Aiven for Caching offering (formerly Aiven for Redis®). Aiven for Caching is entering its end-of-life cycle to comply with Redis’s copyright and license agreements. From February 15th, 2025, it will not be possible to start a new Aiven for Caching service, but existing services up until version 7.2 will still be available until end of life. From March 31st, 2025, Aiven for Caching will no longer be available and all existing services will be migrated to Aiven for Valkey™. You can upgrade to Valkey for free before then and update your existing aiven.Redis resources.

Example Usage

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

const user = aiven.getRedisUser({
    serviceName: "my-service",
    project: "my-project",
    username: "user1",
});
Copy
import pulumi
import pulumi_aiven as aiven

user = aiven.get_redis_user(service_name="my-service",
    project="my-project",
    username="user1")
Copy
package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupRedisUser(ctx, &aiven.LookupRedisUserArgs{
			ServiceName: "my-service",
			Project:     "my-project",
			Username:    "user1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var user = Aiven.GetRedisUser.Invoke(new()
    {
        ServiceName = "my-service",
        Project = "my-project",
        Username = "user1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.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 user = AivenFunctions.getRedisUser(GetRedisUserArgs.builder()
            .serviceName("my-service")
            .project("my-project")
            .username("user1")
            .build());

    }
}
Copy
variables:
  user:
    fn::invoke:
      function: aiven:getRedisUser
      arguments:
        serviceName: my-service
        project: my-project
        username: user1
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(project: Optional[str] = None,
                   service_name: Optional[str] = None,
                   username: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRedisUserResult
def get_redis_user_output(project: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   username: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRedisUserResult]
Copy
func LookupRedisUser(ctx *Context, args *LookupRedisUserArgs, opts ...InvokeOption) (*LookupRedisUserResult, error)
func LookupRedisUserOutput(ctx *Context, args *LookupRedisUserOutputArgs, opts ...InvokeOption) LookupRedisUserResultOutput
Copy

> Note: This function is named LookupRedisUser 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: aiven:index/getRedisUser:getRedisUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Username This property is required. string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Username This property is required. string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
username This property is required. String
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
username This property is required. string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name This property is required. str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
username This property is required. str
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project This property is required. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName This property is required. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
username This property is required. String
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

getRedisUser Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Password string
The password of the Redis User.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
RedisAclCategories List<string>
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
RedisAclChannels List<string>
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
RedisAclCommands List<string>
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
RedisAclKeys List<string>
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
Username string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Password string
The password of the Redis User.
Project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
RedisAclCategories []string
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
RedisAclChannels []string
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
RedisAclCommands []string
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
RedisAclKeys []string
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
ServiceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
Username string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
id String
The provider-assigned unique ID for this managed resource.
password String
The password of the Redis User.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
redisAclCategories List<String>
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclChannels List<String>
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
redisAclCommands List<String>
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclKeys List<String>
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
type String
Type of the user account. Tells whether the user is the primary account or a regular account.
username String
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
id string
The provider-assigned unique ID for this managed resource.
password string
The password of the Redis User.
project string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
redisAclCategories string[]
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclChannels string[]
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
redisAclCommands string[]
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclKeys string[]
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
serviceName string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
type string
Type of the user account. Tells whether the user is the primary account or a regular account.
username string
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
id str
The provider-assigned unique ID for this managed resource.
password str
The password of the Redis User.
project str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
redis_acl_categories Sequence[str]
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
redis_acl_channels Sequence[str]
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
redis_acl_commands Sequence[str]
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
redis_acl_keys Sequence[str]
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
service_name str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
type str
Type of the user account. Tells whether the user is the primary account or a regular account.
username str
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
id String
The provider-assigned unique ID for this managed resource.
password String
The password of the Redis User.
project String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
redisAclCategories List<String>
Defines command category rules. The field is required withredis_acl_commands and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclChannels List<String>
Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
redisAclCommands List<String>
Defines rules for individual commands. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
redisAclKeys List<String>
Defines key access rules. The field is required withredis_acl_categories and redis_acl_keys. Changing this property forces recreation of the resource.
serviceName String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
type String
Type of the user account. Tells whether the user is the primary account or a regular account.
username String
The actual name of the Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven