aiven.RedisUser
Creates and manages an Aiven for Caching (formerly known as Aiven for Redis®) service 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 foo = new aiven.RedisUser("foo", {
    serviceName: bar.serviceName,
    project: "my-project",
    username: "user-1",
    password: "Test$1234",
});
import pulumi
import pulumi_aiven as aiven
foo = aiven.RedisUser("foo",
    service_name=bar["serviceName"],
    project="my-project",
    username="user-1",
    password="Test$1234")
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.NewRedisUser(ctx, "foo", &aiven.RedisUserArgs{
			ServiceName: pulumi.Any(bar.ServiceName),
			Project:     pulumi.String("my-project"),
			Username:    pulumi.String("user-1"),
			Password:    pulumi.String("Test$1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() => 
{
    var foo = new Aiven.RedisUser("foo", new()
    {
        ServiceName = bar.ServiceName,
        Project = "my-project",
        Username = "user-1",
        Password = "Test$1234",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.RedisUser;
import com.pulumi.aiven.RedisUserArgs;
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) {
        var foo = new RedisUser("foo", RedisUserArgs.builder()
            .serviceName(bar.serviceName())
            .project("my-project")
            .username("user-1")
            .password("Test$1234")
            .build());
    }
}
resources:
  foo:
    type: aiven:RedisUser
    properties:
      serviceName: ${bar.serviceName}
      project: my-project
      username: user-1
      password: Test$1234
Create RedisUser Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
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,
              project: Optional[str] = None,
              service_name: Optional[str] = None,
              username: Optional[str] = None,
              password: Optional[str] = None,
              redis_acl_categories: Optional[Sequence[str]] = None,
              redis_acl_channels: Optional[Sequence[str]] = None,
              redis_acl_commands: Optional[Sequence[str]] = None,
              redis_acl_keys: Optional[Sequence[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: aiven: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.
var redisUserResource = new Aiven.RedisUser("redisUserResource", new()
{
    Project = "string",
    ServiceName = "string",
    Username = "string",
    Password = "string",
    RedisAclCategories = new[]
    {
        "string",
    },
    RedisAclChannels = new[]
    {
        "string",
    },
    RedisAclCommands = new[]
    {
        "string",
    },
    RedisAclKeys = new[]
    {
        "string",
    },
});
example, err := aiven.NewRedisUser(ctx, "redisUserResource", &aiven.RedisUserArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Username:    pulumi.String("string"),
	Password:    pulumi.String("string"),
	RedisAclCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	RedisAclChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
	RedisAclCommands: pulumi.StringArray{
		pulumi.String("string"),
	},
	RedisAclKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var redisUserResource = new RedisUser("redisUserResource", RedisUserArgs.builder()
    .project("string")
    .serviceName("string")
    .username("string")
    .password("string")
    .redisAclCategories("string")
    .redisAclChannels("string")
    .redisAclCommands("string")
    .redisAclKeys("string")
    .build());
redis_user_resource = aiven.RedisUser("redisUserResource",
    project="string",
    service_name="string",
    username="string",
    password="string",
    redis_acl_categories=["string"],
    redis_acl_channels=["string"],
    redis_acl_commands=["string"],
    redis_acl_keys=["string"])
const redisUserResource = new aiven.RedisUser("redisUserResource", {
    project: "string",
    serviceName: "string",
    username: "string",
    password: "string",
    redisAclCategories: ["string"],
    redisAclChannels: ["string"],
    redisAclCommands: ["string"],
    redisAclKeys: ["string"],
});
type: aiven:RedisUser
properties:
    password: string
    project: string
    redisAclCategories:
        - string
    redisAclChannels:
        - string
    redisAclCommands:
        - string
    redisAclKeys:
        - string
    serviceName: string
    username: 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:
- 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.
- 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.
- 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.
- Password string
- The password of the Redis User.
- RedisAcl List<string>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl List<string>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- RedisAcl List<string>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl List<string>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- 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.
- 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.
- 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.
- Password string
- The password of the Redis User.
- RedisAcl []stringCategories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl []stringChannels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- RedisAcl []stringCommands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl []stringKeys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- 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.
- 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.
- 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.
- password String
- The password of the Redis User.
- redisAcl List<String>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl List<String>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- 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.
- 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.
- 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.
- password string
- The password of the Redis User.
- redisAcl string[]Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl string[]Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl string[]Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl string[]Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- 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.
- 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.
- 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.
- password str
- The password of the Redis User.
- redis_acl_ Sequence[str]categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- 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.
- 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.
- 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.
- password String
- The password of the Redis User.
- redisAcl List<String>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl List<String>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the RedisUser resource produces the following output properties:
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.
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,
        password: Optional[str] = None,
        project: Optional[str] = None,
        redis_acl_categories: Optional[Sequence[str]] = None,
        redis_acl_channels: Optional[Sequence[str]] = None,
        redis_acl_commands: Optional[Sequence[str]] = None,
        redis_acl_keys: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None) -> RedisUserfunc 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: aiven: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.
- 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.
- RedisAcl List<string>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl List<string>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- RedisAcl List<string>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl List<string>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
- 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.
- RedisAcl []stringCategories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl []stringChannels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- RedisAcl []stringCommands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- RedisAcl []stringKeys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
- 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.
- redisAcl List<String>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl List<String>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
- 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.
- redisAcl string[]Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl string[]Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl string[]Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl string[]Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
- 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_ Sequence[str]categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redis_acl_ Sequence[str]keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
- 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.
- redisAcl List<String>Categories 
- Defines command category rules. The field is required with redis_acl_commandsandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Channels 
- Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource.
- redisAcl List<String>Commands 
- Defines rules for individual commands. The field is required with redis_acl_categoriesandredis_acl_keys. Changing this property forces recreation of the resource.
- redisAcl List<String>Keys 
- Defines key access rules. The field is required with redis_acl_categoriesandredis_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.
Import
$ pulumi import aiven:index/redisUser:RedisUser foo PROJECT/SERVICE_NAME/USERNAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the aivenTerraform Provider.
