1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getOpensearchUser
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v6.53.1
published on Thursday, Apr 23, 2026 by Pulumi

    Gets information about an Aiven for OpenSearch® service user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const exampleOpensearchUser = aiven.getOpensearchUser({
        serviceName: "example-opensearch-service",
        project: exampleProject.project,
        username: "example-opensearch-user",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example_opensearch_user = aiven.get_opensearch_user(service_name="example-opensearch-service",
        project=example_project["project"],
        username="example-opensearch-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.GetOpensearchUser(ctx, &aiven.LookupOpensearchUserArgs{
    			ServiceName: "example-opensearch-service",
    			Project:     exampleProject.Project,
    			Username:    "example-opensearch-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 exampleOpensearchUser = Aiven.Index.GetOpensearchUser.Invoke(new()
        {
            ServiceName = "example-opensearch-service",
            Project = exampleProject.Project,
            Username = "example-opensearch-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.GetOpensearchUserArgs;
    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 exampleOpensearchUser = AivenFunctions.getOpensearchUser(GetOpensearchUserArgs.builder()
                .serviceName("example-opensearch-service")
                .project(exampleProject.project())
                .username("example-opensearch-user")
                .build());
    
        }
    }
    
    variables:
      exampleOpensearchUser:
        fn::invoke:
          function: aiven:getOpensearchUser
          arguments:
            serviceName: example-opensearch-service
            project: ${exampleProject.project}
            username: example-opensearch-user
    

    Using getOpensearchUser

    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 getOpensearchUser(args: GetOpensearchUserArgs, opts?: InvokeOptions): Promise<GetOpensearchUserResult>
    function getOpensearchUserOutput(args: GetOpensearchUserOutputArgs, opts?: InvokeOptions): Output<GetOpensearchUserResult>
    def get_opensearch_user(project: Optional[str] = None,
                            service_name: Optional[str] = None,
                            timeouts: Optional[GetOpensearchUserTimeouts] = None,
                            username: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOpensearchUserResult
    def get_opensearch_user_output(project: Optional[pulumi.Input[str]] = None,
                            service_name: Optional[pulumi.Input[str]] = None,
                            timeouts: Optional[pulumi.Input[GetOpensearchUserTimeoutsArgs]] = None,
                            username: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchUserResult]
    func LookupOpensearchUser(ctx *Context, args *LookupOpensearchUserArgs, opts ...InvokeOption) (*LookupOpensearchUserResult, error)
    func LookupOpensearchUserOutput(ctx *Context, args *LookupOpensearchUserOutputArgs, opts ...InvokeOption) LookupOpensearchUserResultOutput

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

    public static class GetOpensearchUser 
    {
        public static Task<GetOpensearchUserResult> InvokeAsync(GetOpensearchUserArgs args, InvokeOptions? opts = null)
        public static Output<GetOpensearchUserResult> Invoke(GetOpensearchUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOpensearchUserResult> getOpensearchUser(GetOpensearchUserArgs args, InvokeOptions options)
    public static Output<GetOpensearchUserResult> getOpensearchUser(GetOpensearchUserArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getOpensearchUser:getOpensearchUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getOpensearchUser Result

    The following output properties are available:

    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 passwordWo.
    Project string
    Project name.
    ServiceName string
    Service name.
    Type string
    Account type.
    Username string
    Account username.
    Timeouts GetOpensearchUserTimeouts
    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 passwordWo.
    Project string
    Project name.
    ServiceName string
    Service name.
    Type string
    Account type.
    Username string
    Account username.
    Timeouts GetOpensearchUserTimeouts
    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 passwordWo.
    project String
    Project name.
    serviceName String
    Service name.
    type String
    Account type.
    username String
    Account username.
    timeouts GetOpensearchUserTimeouts
    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 passwordWo.
    project string
    Project name.
    serviceName string
    Service name.
    type string
    Account type.
    username string
    Account username.
    timeouts GetOpensearchUserTimeouts
    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 passwordWo.
    project str
    Project name.
    service_name str
    Service name.
    type str
    Account type.
    username str
    Account username.
    timeouts GetOpensearchUserTimeouts
    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 passwordWo.
    project String
    Project name.
    serviceName String
    Service name.
    type String
    Account type.
    username String
    Account username.
    timeouts Property Map

    Supporting Types

    GetOpensearchUserTimeouts

    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
    Viewing docs for Aiven v6.53.1
    published on Thursday, Apr 23, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.