Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. OpensearchUser
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.OpensearchUser

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

The OpenSearch User resource allows the creation and management of Aiven OpenSearch Users.

Example Usage

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

const foo = new aiven.OpensearchUser("foo", {
    serviceName: bar.serviceName,
    project: "my-project",
    username: "user-1",
    password: "Test$1234",
});
Copy
import pulumi
import pulumi_aiven as aiven

foo = aiven.OpensearchUser("foo",
    service_name=bar["serviceName"],
    project="my-project",
    username="user-1",
    password="Test$1234")
Copy
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.NewOpensearchUser(ctx, "foo", &aiven.OpensearchUserArgs{
			ServiceName: pulumi.Any(bar.ServiceName),
			Project:     pulumi.String("my-project"),
			Username:    pulumi.String("user-1"),
			Password:    pulumi.String("Test$1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var foo = new Aiven.OpensearchUser("foo", new()
    {
        ServiceName = bar.ServiceName,
        Project = "my-project",
        Username = "user-1",
        Password = "Test$1234",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.OpensearchUser;
import com.pulumi.aiven.OpensearchUserArgs;
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) {
        var foo = new OpensearchUser("foo", OpensearchUserArgs.builder()
            .serviceName(bar.serviceName())
            .project("my-project")
            .username("user-1")
            .password("Test$1234")
            .build());

    }
}
Copy
resources:
  foo:
    type: aiven:OpensearchUser
    properties:
      serviceName: ${bar.serviceName}
      project: my-project
      username: user-1
      password: Test$1234
Copy

Create OpensearchUser Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OpensearchUser(name: string, args: OpensearchUserArgs, opts?: CustomResourceOptions);
@overload
def OpensearchUser(resource_name: str,
                   args: OpensearchUserArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def OpensearchUser(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project: Optional[str] = None,
                   service_name: Optional[str] = None,
                   username: Optional[str] = None,
                   password: Optional[str] = None)
func NewOpensearchUser(ctx *Context, name string, args OpensearchUserArgs, opts ...ResourceOption) (*OpensearchUser, error)
public OpensearchUser(string name, OpensearchUserArgs args, CustomResourceOptions? opts = null)
public OpensearchUser(String name, OpensearchUserArgs args)
public OpensearchUser(String name, OpensearchUserArgs args, CustomResourceOptions options)

type: aiven:OpensearchUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OpensearchUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OpensearchUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OpensearchUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OpensearchUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OpensearchUserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var opensearchUserResource = new Aiven.OpensearchUser("opensearchUserResource", new()
{
    Project = "string",
    ServiceName = "string",
    Username = "string",
    Password = "string",
});
Copy
example, err := aiven.NewOpensearchUser(ctx, "opensearchUserResource", &aiven.OpensearchUserArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Username:    pulumi.String("string"),
	Password:    pulumi.String("string"),
})
Copy
var opensearchUserResource = new OpensearchUser("opensearchUserResource", OpensearchUserArgs.builder()
    .project("string")
    .serviceName("string")
    .username("string")
    .password("string")
    .build());
Copy
opensearch_user_resource = aiven.OpensearchUser("opensearchUserResource",
    project="string",
    service_name="string",
    username="string",
    password="string")
Copy
const opensearchUserResource = new aiven.OpensearchUser("opensearchUserResource", {
    project: "string",
    serviceName: "string",
    username: "string",
    password: "string",
});
Copy
type: aiven:OpensearchUser
properties:
    password: string
    project: string
    serviceName: string
    username: string
Copy

OpensearchUser Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OpensearchUser resource accepts the following input properties:

Project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Password string
The password of the OpenSearch User.
Project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Password string
The password of the OpenSearch User.
project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password String
The password of the OpenSearch User.
project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password string
The password of the OpenSearch User.
project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password str
The password of the OpenSearch User.
project
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password String
The password of the OpenSearch User.

Outputs

All input properties are implicitly available as output properties. Additionally, the OpensearchUser resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Type of the user account. Tells whether the user is the primary account or a regular account.
id String
The provider-assigned unique ID for this managed resource.
type String
Type of the user account. Tells whether the user is the primary account or a regular account.
id string
The provider-assigned unique ID for this managed resource.
type string
Type of the user account. Tells whether the user is the primary account or a regular account.
id str
The provider-assigned unique ID for this managed resource.
type str
Type of the user account. Tells whether the user is the primary account or a regular account.
id String
The provider-assigned unique ID for this managed resource.
type String
Type of the user account. Tells whether the user is the primary account or a regular account.

Look up Existing OpensearchUser Resource

Get an existing OpensearchUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OpensearchUserState, opts?: CustomResourceOptions): OpensearchUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None) -> OpensearchUser
func GetOpensearchUser(ctx *Context, name string, id IDInput, state *OpensearchUserState, opts ...ResourceOption) (*OpensearchUser, error)
public static OpensearchUser Get(string name, Input<string> id, OpensearchUserState? state, CustomResourceOptions? opts = null)
public static OpensearchUser get(String name, Output<String> id, OpensearchUserState state, CustomResourceOptions options)
resources:  _:    type: aiven:OpensearchUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Password string
The password of the OpenSearch User.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
Username Changes to this property will trigger replacement. string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
Password string
The password of the OpenSearch User.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
Username Changes to this property will trigger replacement. string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password String
The password of the OpenSearch User.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
username Changes to this property will trigger replacement. String
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password string
The password of the OpenSearch User.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
username Changes to this property will trigger replacement. string
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password str
The password of the OpenSearch User.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
username Changes to this property will trigger replacement. str
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
password String
The password of the OpenSearch User.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Type of the user account. Tells whether the user is the primary account or a regular account.
username Changes to this property will trigger replacement. String
The actual name of the OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Import

$ pulumi import aiven:index/opensearchUser:OpensearchUser foo PROJECT/SERVICE_NAME/USERNAME
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven