Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. RedisUser
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

aiven.RedisUser

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

    The Redis User resource allows the creation and management of Aiven Redis Users.

    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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_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.
    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.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RedisUser resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Type of the user account. Tells whether the user is the primary account or a regular account.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of the user account. Tells whether the user is the primary account or a regular account.

    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) -> 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)
    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:
    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.
    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.
    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.
    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.
    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.
    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.

    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 aiven Terraform Provider.
    aiven logo
    Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-aiven