1. Packages
  2. Aiven Provider
  3. API Docs
  4. getMysqlUser
Aiven v6.48.0 published on Wednesday, Jan 28, 2026 by Pulumi
aiven logo
Aiven v6.48.0 published on Wednesday, Jan 28, 2026 by Pulumi

    Gets information about an Aiven for MySQL® service user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const exampleMysqlUser = aiven.getMysqlUser({
        serviceName: exampleMysql.serviceName,
        project: exampleProject.project,
        username: "example-mysql-user",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example_mysql_user = aiven.get_mysql_user(service_name=example_mysql["serviceName"],
        project=example_project["project"],
        username="example-mysql-user")
    
    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.LookupMysqlUser(ctx, &aiven.LookupMysqlUserArgs{
    			ServiceName: exampleMysql.ServiceName,
    			Project:     exampleProject.Project,
    			Username:    "example-mysql-user",
    		}, 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 exampleMysqlUser = Aiven.GetMysqlUser.Invoke(new()
        {
            ServiceName = exampleMysql.ServiceName,
            Project = exampleProject.Project,
            Username = "example-mysql-user",
        });
    
    });
    
    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.GetMysqlUserArgs;
    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 exampleMysqlUser = AivenFunctions.getMysqlUser(GetMysqlUserArgs.builder()
                .serviceName(exampleMysql.serviceName())
                .project(exampleProject.project())
                .username("example-mysql-user")
                .build());
    
        }
    }
    
    variables:
      exampleMysqlUser:
        fn::invoke:
          function: aiven:getMysqlUser
          arguments:
            serviceName: ${exampleMysql.serviceName}
            project: ${exampleProject.project}
            username: example-mysql-user
    

    Using getMysqlUser

    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 getMysqlUser(args: GetMysqlUserArgs, opts?: InvokeOptions): Promise<GetMysqlUserResult>
    function getMysqlUserOutput(args: GetMysqlUserOutputArgs, opts?: InvokeOptions): Output<GetMysqlUserResult>
    def get_mysql_user(project: Optional[str] = None,
                       service_name: Optional[str] = None,
                       timeouts: Optional[GetMysqlUserTimeouts] = None,
                       username: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetMysqlUserResult
    def get_mysql_user_output(project: Optional[pulumi.Input[str]] = None,
                       service_name: Optional[pulumi.Input[str]] = None,
                       timeouts: Optional[pulumi.Input[GetMysqlUserTimeoutsArgs]] = None,
                       username: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetMysqlUserResult]
    func LookupMysqlUser(ctx *Context, args *LookupMysqlUserArgs, opts ...InvokeOption) (*LookupMysqlUserResult, error)
    func LookupMysqlUserOutput(ctx *Context, args *LookupMysqlUserOutputArgs, opts ...InvokeOption) LookupMysqlUserResultOutput

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

    public static class GetMysqlUser 
    {
        public static Task<GetMysqlUserResult> InvokeAsync(GetMysqlUserArgs args, InvokeOptions? opts = null)
        public static Output<GetMysqlUserResult> Invoke(GetMysqlUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMysqlUserResult> getMysqlUser(GetMysqlUserArgs args, InvokeOptions options)
    public static Output<GetMysqlUserResult> getMysqlUser(GetMysqlUserArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getMysqlUser:getMysqlUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    Project name.
    ServiceName string
    The name of the MySQL® service user.
    Username string
    The name of the MySQL® service user.
    Timeouts GetMysqlUserTimeouts
    Project string
    Project name.
    ServiceName string
    The name of the MySQL® service user.
    Username string
    The name of the MySQL® service user.
    Timeouts GetMysqlUserTimeouts
    project String
    Project name.
    serviceName String
    The name of the MySQL® service user.
    username String
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    project string
    Project name.
    serviceName string
    The name of the MySQL® service user.
    username string
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    project str
    Project name.
    service_name str
    The name of the MySQL® service user.
    username str
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    project String
    Project name.
    serviceName String
    The name of the MySQL® service user.
    username String
    The name of the MySQL® service user.
    timeouts Property Map

    getMysqlUser Result

    The following output properties are available:

    AccessCert string
    Access certificate for TLS client authentication.
    AccessKey string
    Access key for TLS client authentication.
    Authentication string
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    Id string
    Resource ID composed as: project/service_name/username.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    PasswordWo string
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    PasswordWoVersion int
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    Project string
    Project name.
    ServiceName string
    The name of the MySQL® service user.
    Type string
    User account type, such as primary or regular account.
    Username string
    The name of the MySQL® service user.
    Timeouts GetMysqlUserTimeouts
    AccessCert string
    Access certificate for TLS client authentication.
    AccessKey string
    Access key for TLS client authentication.
    Authentication string
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    Id string
    Resource ID composed as: project/service_name/username.
    Password string
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    PasswordWo string
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    PasswordWoVersion int
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    Project string
    Project name.
    ServiceName string
    The name of the MySQL® service user.
    Type string
    User account type, such as primary or regular account.
    Username string
    The name of the MySQL® service user.
    Timeouts GetMysqlUserTimeouts
    accessCert String
    Access certificate for TLS client authentication.
    accessKey String
    Access key for TLS client authentication.
    authentication String
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    id String
    Resource ID composed as: project/service_name/username.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    passwordWo String
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    passwordWoVersion Integer
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    project String
    Project name.
    serviceName String
    The name of the MySQL® service user.
    type String
    User account type, such as primary or regular account.
    username String
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    accessCert string
    Access certificate for TLS client authentication.
    accessKey string
    Access key for TLS client authentication.
    authentication string
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    id string
    Resource ID composed as: project/service_name/username.
    password string
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    passwordWo string
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    passwordWoVersion number
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    project string
    Project name.
    serviceName string
    The name of the MySQL® service user.
    type string
    User account type, such as primary or regular account.
    username string
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    access_cert str
    Access certificate for TLS client authentication.
    access_key str
    Access key for TLS client authentication.
    authentication str
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    id str
    Resource ID composed as: project/service_name/username.
    password str
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    password_wo str
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    password_wo_version int
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    project str
    Project name.
    service_name str
    The name of the MySQL® service user.
    type str
    User account type, such as primary or regular account.
    username str
    The name of the MySQL® service user.
    timeouts GetMysqlUserTimeouts
    accessCert String
    Access certificate for TLS client authentication.
    accessKey String
    Access key for TLS client authentication.
    authentication String
    Service specific authentication details. Currently only used for MySQL where accepted options are 'mysqlnativepassword' and 'cachingsha2password', latter being default when this is not explicitly set. The possible values are caching_sha2_password and mysql_native_password.
    id String
    Resource ID composed as: project/service_name/username.
    password String
    The password of the service user (auto-generated if not provided). The field conflicts with password_wo.
    passwordWo String
    The password of the service user (write-only, not stored in state). The field is required with password_wo_version. The field conflicts with password.
    passwordWoVersion Number
    Version number for password_wo. Increment this to rotate the password. The field is required with password_wo.
    project String
    Project name.
    serviceName String
    The name of the MySQL® service user.
    type String
    User account type, such as primary or regular account.
    username String
    The name of the MySQL® service user.
    timeouts Property Map

    Supporting Types

    GetMysqlUserTimeouts

    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 v6.48.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate