Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. opensearch
  6. User
Viewing docs for Scaleway v1.59.0
published on Wednesday, Oct 21, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.opensearch.User

scaleway logo
Viewing docs for Scaleway v1.59.0
published on Wednesday, Oct 21, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    Creates and manages OpenSearch users on a Scaleway OpenSearch deployment. For more information refer to the product documentation and the API documentation.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const main = new scaleway.opensearch.Deployment("main", {
    name: "my-opensearch-cluster",
    version: "2.0",
    nodeCount: 1,
    nodeType: "SEARCHDB-SHARED-2C-8G",
    userName: "admin",
    password: "ThisIsASecurePassword123!",
    volume: {
        type: "sbs_5k",
        sizeInGb: 5,
    },
});
const app = new scaleway.opensearch.User("app", {
    deploymentId: main.id,
    name: "app_user",
    password: "ThisIsASecurePassword123!",
});

    import pulumi
import pulumiverse_scaleway as scaleway

main = scaleway.opensearch.Deployment("main",
    name="my-opensearch-cluster",
    version="2.0",
    node_count=1,
    node_type="SEARCHDB-SHARED-2C-8G",
    user_name="admin",
    password="ThisIsASecurePassword123!",
    volume={
        "type": "sbs_5k",
        "size_in_gb": 5,
    })
app = scaleway.opensearch.User("app",
    deployment_id=main.id,
    name="app_user",
    password="ThisIsASecurePassword123!")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/opensearch"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := opensearch.NewDeployment(ctx, "main", &opensearch.DeploymentArgs{
			Name:      pulumi.String("my-opensearch-cluster"),
			Version:   pulumi.String("2.0"),
			NodeCount: pulumi.Int(1),
			NodeType:  pulumi.String("SEARCHDB-SHARED-2C-8G"),
			UserName:  pulumi.String("admin"),
			Password:  pulumi.String("ThisIsASecurePassword123!"),
			Volume: &opensearch.DeploymentVolumeArgs{
				Type:     pulumi.String("sbs_5k"),
				SizeInGb: pulumi.Int(5),
			},
		})
		if err != nil {
			return err
		}
		_, err = opensearch.NewUser(ctx, "app", &opensearch.UserArgs{
			DeploymentId: main.ID().ToIDOutput().ToStringOutput(),
			Name:         pulumi.String("app_user"),
			Password:     pulumi.String("ThisIsASecurePassword123!"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var main = new Scaleway.Opensearch.Deployment("main", new()
    {
        Name = "my-opensearch-cluster",
        Version = "2.0",
        NodeCount = 1,
        NodeType = "SEARCHDB-SHARED-2C-8G",
        UserName = "admin",
        Password = "ThisIsASecurePassword123!",
        Volume = new Scaleway.Opensearch.Inputs.DeploymentVolumeArgs
        {
            Type = "sbs_5k",
            SizeInGb = 5,
        },
    });

    var app = new Scaleway.Opensearch.User("app", new()
    {
        DeploymentId = main.Id,
        Name = "app_user",
        Password = "ThisIsASecurePassword123!",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.opensearch.Deployment;
import com.pulumi.scaleway.opensearch.DeploymentArgs;
import com.pulumi.scaleway.opensearch.inputs.DeploymentVolumeArgs;
import com.pulumi.scaleway.opensearch.User;
import com.pulumi.scaleway.opensearch.UserArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 main = new Deployment("main", DeploymentArgs.builder()
            .name("my-opensearch-cluster")
            .version("2.0")
            .nodeCount(1)
            .nodeType("SEARCHDB-SHARED-2C-8G")
            .userName("admin")
            .password("ThisIsASecurePassword123!")
            .volume(DeploymentVolumeArgs.builder()
                .type("sbs_5k")
                .sizeInGb(5)
                .build())
            .build());

        var app = new User("app", UserArgs.builder()
            .deploymentId(main.id())
            .name("app_user")
            .password("ThisIsASecurePassword123!")
            .build());

    }
}

    resources:
  main:
    type: scaleway:opensearch:Deployment
    properties:
      name: my-opensearch-cluster
      version: '2.0'
      nodeCount: 1
      nodeType: SEARCHDB-SHARED-2C-8G
      userName: admin
      password: ThisIsASecurePassword123!
      volume:
        type: sbs_5k
        sizeInGb: 5
  app:
    type: scaleway:opensearch:User
    properties:
      deploymentId: ${main.id}
      name: app_user
      password: ThisIsASecurePassword123!

    pulumi {
  required_providers {
    scaleway = {
      source = "pulumi/scaleway"
    }
  }
}

resource "scaleway_opensearch_deployment" "main" {
  name       = "my-opensearch-cluster"
  version    = "2.0"
  node_count = 1
  node_type  = "SEARCHDB-SHARED-2C-8G"
  user_name  = "admin"
  password   = "ThisIsASecurePassword123!"
  volume = {
    type       = "sbs_5k"
    size_in_gb = 5
  }
}
resource "scaleway_opensearch_user" "app" {
  deployment_id = scaleway_opensearch_deployment.main.id
  name          = "app_user"
  password      = "ThisIsASecurePassword123!"
}

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         deployment_id: Optional[str] = None,
         name: Optional[str] = None,
         password: Optional[str] = None,
         password_wo: Optional[str] = None,
         password_wo_version: Optional[int] = None,
         region: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: scaleway:opensearch:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "scaleway_opensearch_user" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 exampleuserResourceResourceFromOpensearchuser = new Scaleway.Opensearch.User("exampleuserResourceResourceFromOpensearchuser", new()
{
    DeploymentId = "string",
    Name = "string",
    Password = "string",
    PasswordWo = "string",
    PasswordWoVersion = 0,
    Region = "string",
});

    example, err := opensearch.NewUser(ctx, "exampleuserResourceResourceFromOpensearchuser", &opensearch.UserArgs{
	DeploymentId:      pulumi.String("string"),
	Name:              pulumi.String("string"),
	Password:          pulumi.String("string"),
	PasswordWo:        pulumi.String("string"),
	PasswordWoVersion: pulumi.Int(0),
	Region:            pulumi.String("string"),
})

    resource "scaleway_opensearch_user" "exampleuserResourceResourceFromOpensearchuser" {
  lifecycle {
    create_before_destroy = true
  }
  deployment_id       = "string"
  name                = "string"
  password            = "string"
  password_wo         = "string"
  password_wo_version = 0
  region              = "string"
}

    var exampleuserResourceResourceFromOpensearchuser = new com.pulumi.scaleway.opensearch.User("exampleuserResourceResourceFromOpensearchuser", com.pulumi.scaleway.opensearch.UserArgs.builder()
    .deploymentId("string")
    .name("string")
    .password("string")
    .passwordWo("string")
    .passwordWoVersion(0)
    .region("string")
    .build());

    exampleuser_resource_resource_from_opensearchuser = scaleway.opensearch.User("exampleuserResourceResourceFromOpensearchuser",
    deployment_id="string",
    name="string",
    password="string",
    password_wo="string",
    password_wo_version=0,
    region="string")

    const exampleuserResourceResourceFromOpensearchuser = new scaleway.opensearch.User("exampleuserResourceResourceFromOpensearchuser", {
    deploymentId: "string",
    name: "string",
    password: "string",
    passwordWo: "string",
    passwordWoVersion: 0,
    region: "string",
});

    type: scaleway:opensearch:User
properties:
    deploymentId: string
    name: string
    password: string
    passwordWo: string
    passwordWoVersion: 0
    region: string

    User 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 User resource accepts the following input properties:

    DeploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    Name string
    Name of the OpenSearch user.
    Password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    PasswordWoVersion int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    Region string
    region) The region in which the user should be created.
    DeploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    Name string
    Name of the OpenSearch user.
    Password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    PasswordWoVersion int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    Region string
    region) The region in which the user should be created.
    deployment_id string
    The ID of the OpenSearch deployment the user belongs to.
    name string
    Name of the OpenSearch user.
    password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    password_wo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    password_wo_version number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region string
    region) The region in which the user should be created.
    deploymentId String
    The ID of the OpenSearch deployment the user belongs to.
    name String
    Name of the OpenSearch user.
    password String
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion Integer
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region String
    region) The region in which the user should be created.
    deploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    name string
    Name of the OpenSearch user.
    password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region string
    region) The region in which the user should be created.
    deployment_id str
    The ID of the OpenSearch deployment the user belongs to.
    name str
    Name of the OpenSearch user.
    password str
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    password_wo_version int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region str
    region) The region in which the user should be created.
    deploymentId String
    The ID of the OpenSearch deployment the user belongs to.
    name String
    Name of the OpenSearch user.
    password String
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion Number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region String
    region) The region in which the user should be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deployment_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_wo: Optional[str] = None,
        password_wo_version: Optional[int] = None,
        region: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:opensearch:User    get:      id: ${id}
    import {
  to = scaleway_opensearch_user.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    DeploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    Name string
    Name of the OpenSearch user.
    Password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    PasswordWoVersion int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    Region string
    region) The region in which the user should be created.
    DeploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    Name string
    Name of the OpenSearch user.
    Password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    PasswordWoVersion int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    Region string
    region) The region in which the user should be created.
    deployment_id string
    The ID of the OpenSearch deployment the user belongs to.
    name string
    Name of the OpenSearch user.
    password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    password_wo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    password_wo_version number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region string
    region) The region in which the user should be created.
    deploymentId String
    The ID of the OpenSearch deployment the user belongs to.
    name String
    Name of the OpenSearch user.
    password String
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion Integer
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region String
    region) The region in which the user should be created.
    deploymentId string
    The ID of the OpenSearch deployment the user belongs to.
    name string
    Name of the OpenSearch user.
    password string
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region string
    region) The region in which the user should be created.
    deployment_id str
    The ID of the OpenSearch deployment the user belongs to.
    name str
    Name of the OpenSearch user.
    password str
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    password_wo_version int
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region str
    region) The region in which the user should be created.
    deploymentId String
    The ID of the OpenSearch deployment the user belongs to.
    name String
    Name of the OpenSearch user.
    password String
    Password for the OpenSearch user. Only one of password and passwordWo should be specified.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the OpenSearch user in write-only mode. Only one of password and passwordWo should be specified. passwordWo is not stored in the Terraform state. To update it, also update passwordWoVersion.
    passwordWoVersion Number
    Version of the write-only password. Required when passwordWo is set; bump this value to rotate the password.
    region String
    region) The region in which the user should be created.

    Import

    OpenSearch users can be imported using {region}/{deployment_id}/{name}, e.g.

    $ pulumi import scaleway:opensearch/user:User app fr-par/11111111-1111-1111-1111-111111111111/app_user

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

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.59.0
    published on Wednesday, Oct 21, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial