getPgUser

Aiven v6.50.0, Feb 27 26

Viewing docs for Aiven v6.50.0
published on Friday, Feb 27, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v6.50.0
published on Friday, Feb 27, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

Example Usage

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

const exampleUser = aiven.getPgUser({
    serviceName: examplePostgres.serviceName,
    project: exampleProject.project,
    username: "example-service-user",
});

import pulumi
import pulumi_aiven as aiven

example_user = aiven.get_pg_user(service_name=example_postgres["serviceName"],
    project=example_project["project"],
    username="example-service-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.LookupPgUser(ctx, &aiven.LookupPgUserArgs{
			ServiceName: examplePostgres.ServiceName,
			Project:     exampleProject.Project,
			Username:    "example-service-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 exampleUser = Aiven.GetPgUser.Invoke(new()
    {
        ServiceName = examplePostgres.ServiceName,
        Project = exampleProject.Project,
        Username = "example-service-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.GetPgUserArgs;
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 exampleUser = AivenFunctions.getPgUser(GetPgUserArgs.builder()
            .serviceName(examplePostgres.serviceName())
            .project(exampleProject.project())
            .username("example-service-user")
            .build());

    }
}

variables:
  exampleUser:
    fn::invoke:
      function: aiven:getPgUser
      arguments:
        serviceName: ${examplePostgres.serviceName}
        project: ${exampleProject.project}
        username: example-service-user

Using getPgUser

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 getPgUser(args: GetPgUserArgs, opts?: InvokeOptions): Promise<GetPgUserResult>
function getPgUserOutput(args: GetPgUserOutputArgs, opts?: InvokeOptions): Output<GetPgUserResult>

def get_pg_user(project: Optional[str] = None,
                service_name: Optional[str] = None,
                timeouts: Optional[GetPgUserTimeouts] = None,
                username: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetPgUserResult
def get_pg_user_output(project: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                timeouts: Optional[pulumi.Input[GetPgUserTimeoutsArgs]] = None,
                username: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPgUserResult]

func LookupPgUser(ctx *Context, args *LookupPgUserArgs, opts ...InvokeOption) (*LookupPgUserResult, error)
func LookupPgUserOutput(ctx *Context, args *LookupPgUserOutputArgs, opts ...InvokeOption) LookupPgUserResultOutput

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

public static class GetPgUser 
{
    public static Task<GetPgUserResult> InvokeAsync(GetPgUserArgs args, InvokeOptions? opts = null)
    public static Output<GetPgUserResult> Invoke(GetPgUserInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPgUserResult> getPgUser(GetPgUserArgs args, InvokeOptions options)
public static Output<GetPgUserResult> getPgUser(GetPgUserArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getPgUser:getPgUser
  arguments:
    # arguments dictionary

The following arguments are supported:

Project string: Project name.
ServiceName string: The name of the service.
Username string: The name of the service user for this service.
Timeouts GetPgUserTimeouts

Project string: Project name.
ServiceName string: The name of the service.
Username string: The name of the service user for this service.
Timeouts GetPgUserTimeouts

project String: Project name.
serviceName String: The name of the service.
username String: The name of the service user for this service.
timeouts GetPgUserTimeouts

project string: Project name.
serviceName string: The name of the service.
username string: The name of the service user for this service.
timeouts GetPgUserTimeouts

project str: Project name.
service_name str: The name of the service.
username str: The name of the service user for this service.
timeouts GetPgUserTimeouts

project String: Project name.
serviceName String: The name of the service.
username String: The name of the service user for this service.
timeouts Property Map

getPgUser Result

The following output properties are available:

AccessCert string: Access certificate for TLS client authentication.
AccessKey string: Access key for TLS client authentication.
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.
PgAllowReplication bool: Allows replication. For the default avnadmin user this attribute is required and is always true.
Project string: Project name.
ServiceName string: The name of the service.
Type string: The service user account type, either primary or regular.
Username string: The name of the service user for this service.
Timeouts GetPgUserTimeouts

AccessCert string: Access certificate for TLS client authentication.
AccessKey string: Access key for TLS client authentication.
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.
PgAllowReplication bool: Allows replication. For the default avnadmin user this attribute is required and is always true.
Project string: Project name.
ServiceName string: The name of the service.
Type string: The service user account type, either primary or regular.
Username string: The name of the service user for this service.
Timeouts GetPgUserTimeouts

accessCert String: Access certificate for TLS client authentication.
accessKey String: Access key for TLS client authentication.
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.
pgAllowReplication Boolean: Allows replication. For the default avnadmin user this attribute is required and is always true.
project String: Project name.
serviceName String: The name of the service.
type String: The service user account type, either primary or regular.
username String: The name of the service user for this service.
timeouts GetPgUserTimeouts

accessCert string: Access certificate for TLS client authentication.
accessKey string: Access key for TLS client authentication.
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.
pgAllowReplication boolean: Allows replication. For the default avnadmin user this attribute is required and is always true.
project string: Project name.
serviceName string: The name of the service.
type string: The service user account type, either primary or regular.
username string: The name of the service user for this service.
timeouts GetPgUserTimeouts

access_cert str: Access certificate for TLS client authentication.
access_key str: Access key for TLS client authentication.
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.
pg_allow_replication bool: Allows replication. For the default avnadmin user this attribute is required and is always true.
project str: Project name.
service_name str: The name of the service.
type str: The service user account type, either primary or regular.
username str: The name of the service user for this service.
timeouts GetPgUserTimeouts

accessCert String: Access certificate for TLS client authentication.
accessKey String: Access key for TLS client authentication.
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.
pgAllowReplication Boolean: Allows replication. For the default avnadmin user this attribute is required and is always true.
project String: Project name.
serviceName String: The name of the service.
type String: The service user account type, either primary or regular.
username String: The name of the service user for this service.
timeouts Property Map

Supporting Types

GetPgUserTimeouts

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.

Viewing docs for Aiven v6.50.0
published on Friday, Feb 27, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aiven

aiven.getPgUser

On this page

On this page

Example Usage

Using getPgUser

getPgUser Result

Supporting Types

GetPgUserTimeouts

Package Details

On this page

On this page