1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getValkeyUser
Viewing docs for Aiven v6.60.0
published on Wednesday, Sep 23, 2026 by Pulumi
aiven logo aiven logo
Viewing docs for Aiven v6.60.0
published on Wednesday, Sep 23, 2026 by Pulumi

    Gets information about an Aiven for Valkey™ service user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = aiven.getValkeyUser({
        project: "my-project",
        serviceName: "my-valkey",
        username: "testuser",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.get_valkey_user(project="my-project",
        service_name="my-valkey",
        username="testuser")
    
    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.GetValkeyUser(ctx, &aiven.LookupValkeyUserArgs{
    			Project:     "my-project",
    			ServiceName: "my-valkey",
    			Username:    "testuser",
    		}, nil)
    		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 example = Aiven.GetValkeyUser.Invoke(new()
        {
            Project = "my-project",
            ServiceName = "my-valkey",
            Username = "testuser",
        });
    
    });
    
    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.GetValkeyUserArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = AivenFunctions.getValkeyUser(GetValkeyUserArgs.builder()
                .project("my-project")
                .serviceName("my-valkey")
                .username("testuser")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aiven:getValkeyUser
          arguments:
            project: my-project
            serviceName: my-valkey
            username: testuser
    
    pulumi {
      required_providers {
        aiven = {
          source = "pulumi/aiven"
        }
      }
    }
    
    data "aiven_getvalkeyuser" "example" {
      project      = "my-project"
      service_name = "my-valkey"
      username     = "testuser"
    }
    

    Using getValkeyUser

    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 getValkeyUser(args: GetValkeyUserArgs, opts?: InvokeOptions): Promise<GetValkeyUserResult>
    function getValkeyUserOutput(args: GetValkeyUserOutputArgs, opts?: InvokeOutputOptions): Output<GetValkeyUserResult>
    def get_valkey_user(project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        timeouts: Optional[GetValkeyUserTimeouts] = None,
                        username: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetValkeyUserResult
    def get_valkey_user_output(project: pulumi.Input[Optional[str]] = None,
                        service_name: pulumi.Input[Optional[str]] = None,
                        timeouts: pulumi.Input[Optional[GetValkeyUserTimeoutsArgs]] = None,
                        username: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetValkeyUserResult]
    func LookupValkeyUser(ctx *Context, args *LookupValkeyUserArgs, opts ...InvokeOption) (*LookupValkeyUserResult, error)
    func LookupValkeyUserOutput(ctx *Context, args *LookupValkeyUserOutputArgs, opts ...InvokeOption) LookupValkeyUserResultOutput

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

    public static class GetValkeyUser 
    {
        public static Task<GetValkeyUserResult> InvokeAsync(GetValkeyUserArgs args, InvokeOptions? opts = null)
        public static Output<GetValkeyUserResult> Invoke(GetValkeyUserInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetValkeyUserResult> Invoke(GetValkeyUserInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetValkeyUserResult> getValkeyUser(GetValkeyUserArgs args, InvokeOptions options)
    public static Output<GetValkeyUserResult> getValkeyUser(GetValkeyUserArgs args, InvokeOptions options)
    public static Output<GetValkeyUserResult> getValkeyUser(GetValkeyUserArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aiven:index/getValkeyUser:getValkeyUser
      arguments:
        # arguments dictionary
    data "aiven_get_valkey_user" "name" {
        # arguments
    }

    The following arguments are supported:

    Project string
    Project name.
    ServiceName string
    Service name.
    Username string
    Service username.
    Timeouts GetValkeyUserTimeouts
    Project string
    Project name.
    ServiceName string
    Service name.
    Username string
    Service username.
    Timeouts GetValkeyUserTimeouts
    project string
    Project name.
    service_name string
    Service name.
    username string
    Service username.
    timeouts object
    project String
    Project name.
    serviceName String
    Service name.
    username String
    Service username.
    timeouts GetValkeyUserTimeouts
    project string
    Project name.
    serviceName string
    Service name.
    username string
    Service username.
    timeouts GetValkeyUserTimeouts
    project str
    Project name.
    service_name str
    Service name.
    username str
    Service username.
    timeouts GetValkeyUserTimeouts
    project String
    Project name.
    serviceName String
    Service name.
    username String
    Service username.
    timeouts Property Map

    getValkeyUser Result

    The following output properties are available:

    Id string
    Resource ID composed as: project/service_name/username.
    MysqlGrants List<string>
    MySQL grants for the service user.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    PasswordEncryptionType string
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    Project string
    Project name.
    ServiceName string
    Service name.
    Type string
    Account type.
    Username string
    Service username.
    ValkeyAclCategories List<string>
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    ValkeyAclChannels List<string>
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    ValkeyAclCommands List<string>
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    ValkeyAclKeys List<string>
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    Timeouts GetValkeyUserTimeouts
    Id string
    Resource ID composed as: project/service_name/username.
    MysqlGrants []string
    MySQL grants for the service user.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    PasswordEncryptionType string
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    Project string
    Project name.
    ServiceName string
    Service name.
    Type string
    Account type.
    Username string
    Service username.
    ValkeyAclCategories []string
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    ValkeyAclChannels []string
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    ValkeyAclCommands []string
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    ValkeyAclKeys []string
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    Timeouts GetValkeyUserTimeouts
    id string
    Resource ID composed as: project/service_name/username.
    mysql_grants list(string)
    MySQL grants for the service user.
    password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    password_encryption_type string
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    project string
    Project name.
    service_name string
    Service name.
    type string
    Account type.
    username string
    Service username.
    valkey_acl_categories list(string)
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    valkey_acl_channels list(string)
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    valkey_acl_commands list(string)
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    valkey_acl_keys list(string)
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    timeouts object
    id String
    Resource ID composed as: project/service_name/username.
    mysqlGrants List<String>
    MySQL grants for the service user.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    passwordEncryptionType String
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    project String
    Project name.
    serviceName String
    Service name.
    type String
    Account type.
    username String
    Service username.
    valkeyAclCategories List<String>
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    valkeyAclChannels List<String>
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    valkeyAclCommands List<String>
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    valkeyAclKeys List<String>
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    timeouts GetValkeyUserTimeouts
    id string
    Resource ID composed as: project/service_name/username.
    mysqlGrants string[]
    MySQL grants for the service user.
    password string
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    passwordEncryptionType string
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    project string
    Project name.
    serviceName string
    Service name.
    type string
    Account type.
    username string
    Service username.
    valkeyAclCategories string[]
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    valkeyAclChannels string[]
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    valkeyAclCommands string[]
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    valkeyAclKeys string[]
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    timeouts GetValkeyUserTimeouts
    id str
    Resource ID composed as: project/service_name/username.
    mysql_grants Sequence[str]
    MySQL grants for the service user.
    password str
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    password_encryption_type str
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    project str
    Project name.
    service_name str
    Service name.
    type str
    Account type.
    username str
    Service username.
    valkey_acl_categories Sequence[str]
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    valkey_acl_channels Sequence[str]
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    valkey_acl_commands Sequence[str]
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    valkey_acl_keys Sequence[str]
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    timeouts GetValkeyUserTimeouts
    id String
    Resource ID composed as: project/service_name/username.
    mysqlGrants List<String>
    MySQL grants for the service user.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with passwordWo.
    passwordEncryptionType String
    The password hashing algorithm used for this PostgreSQL user, derived from the stored password hash. 'unknown' is reported when the hash is missing or uses an unrecognised format. The possible values are md5, scram-sha-256 and unknown.
    project String
    Project name.
    serviceName String
    Service name.
    type String
    Account type.
    username String
    Service username.
    valkeyAclCategories List<String>
    Allow or disallow command categories. To allow a category use the prefix +@ and to disallow use -@. See the Valkey documentation for details on the ACL feature. The field is required with valkeyAclCommands and valkeyAclKeys.
    valkeyAclChannels List<String>
    Allows and disallows access to pub/sub channels. Entries are defined as standard glob patterns.
    valkeyAclCommands List<String>
    Defines rules for individual commands. To allow a command use the prefix + and to disallow use -. The field is required with valkeyAclCategories and valkeyAclKeys.
    valkeyAclKeys List<String>
    Key access rules. Entries are defined as standard glob patterns. The field is required with valkeyAclCategories and valkeyAclCommands.
    timeouts Property Map

    Supporting Types

    GetValkeyUserTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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 logo
    Viewing docs for Aiven v6.60.0
    published on Wednesday, Sep 23, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial