Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getPgUser
Aiven v6.39.0 published on Tuesday, Jun 3, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getPgUser

Explore with Pulumi AI

aiven logo
Aiven v6.39.0 published on Tuesday, Jun 3, 2025 by Pulumi
pulumi/pulumi-aiven

    Gets information about an Aiven for PostgreSQL® service user.

    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,
                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,
                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
    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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. 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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. 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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. 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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. 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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. 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 name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    getPgUser Result

    The following output properties are available:

    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    Type string
    The service user account type, either primary or regular.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    Type string
    The service user account type, either primary or regular.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    type String
    The service user account type, either primary or regular.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert string
    The access certificate for the servie user.
    accessKey string
    The access certificate key for the service user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    The password of the service user.
    pgAllowReplication boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    type string
    The service user account type, either primary or regular.
    username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    access_cert str
    The access certificate for the servie user.
    access_key str
    The access certificate key for the service user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    The password of the service user.
    pg_allow_replication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    type str
    The service user account type, either primary or regular.
    username str
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    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.
    type String
    The service user account type, either primary or regular.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    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.39.0 published on Tuesday, Jun 3, 2025 by Pulumi
    pulumi/pulumi-aiven