1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. ElasticsearchSecurityUser
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.ElasticsearchSecurityUser

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    Adds and updates users in the native realm. These users are commonly referred to as native users. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const user = new elasticstack.ElasticsearchSecurityUser("user", {
        username: "testuser",
        passwordHash: "$2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO",
        roles: ["kibana_user"],
        metadata: JSON.stringify({
            env: "testing",
            open: false,
            number: 49,
        }),
        elasticsearchConnection: {
            endpoints: ["http://localhost:9200"],
            username: "elastic",
            password: "changeme",
        },
    });
    const dev = new elasticstack.ElasticsearchSecurityUser("dev", {
        username: "devuser",
        password: "1234567890",
        roles: ["kibana_user"],
        metadata: JSON.stringify({
            env: "testing",
            open: false,
            number: 49,
        }),
    });
    
    import pulumi
    import json
    import pulumi_elasticstack as elasticstack
    
    user = elasticstack.ElasticsearchSecurityUser("user",
        username="testuser",
        password_hash="$2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO",
        roles=["kibana_user"],
        metadata=json.dumps({
            "env": "testing",
            "open": False,
            "number": 49,
        }),
        elasticsearch_connection={
            "endpoints": ["http://localhost:9200"],
            "username": "elastic",
            "password": "changeme",
        })
    dev = elasticstack.ElasticsearchSecurityUser("dev",
        username="devuser",
        password="1234567890",
        roles=["kibana_user"],
        metadata=json.dumps({
            "env": "testing",
            "open": False,
            "number": 49,
        }))
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"env":    "testing",
    			"open":   false,
    			"number": 49,
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = elasticstack.NewElasticsearchSecurityUser(ctx, "user", &elasticstack.ElasticsearchSecurityUserArgs{
    			Username:     pulumi.String("testuser"),
    			PasswordHash: pulumi.String("$2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO"),
    			Roles: pulumi.StringArray{
    				pulumi.String("kibana_user"),
    			},
    			Metadata: pulumi.String(json0),
    			ElasticsearchConnection: &elasticstack.ElasticsearchSecurityUserElasticsearchConnectionArgs{
    				Endpoints: pulumi.StringArray{
    					pulumi.String("http://localhost:9200"),
    				},
    				Username: pulumi.String("elastic"),
    				Password: pulumi.String("changeme"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		tmpJSON1, err := json.Marshal(map[string]interface{}{
    			"env":    "testing",
    			"open":   false,
    			"number": 49,
    		})
    		if err != nil {
    			return err
    		}
    		json1 := string(tmpJSON1)
    		_, err = elasticstack.NewElasticsearchSecurityUser(ctx, "dev", &elasticstack.ElasticsearchSecurityUserArgs{
    			Username: pulumi.String("devuser"),
    			Password: pulumi.String("1234567890"),
    			Roles: pulumi.StringArray{
    				pulumi.String("kibana_user"),
    			},
    			Metadata: pulumi.String(json1),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Elasticstack = Pulumi.Elasticstack;
    
    return await Deployment.RunAsync(() => 
    {
        var user = new Elasticstack.ElasticsearchSecurityUser("user", new()
        {
            Username = "testuser",
            PasswordHash = "$2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO",
            Roles = new[]
            {
                "kibana_user",
            },
            Metadata = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["env"] = "testing",
                ["open"] = false,
                ["number"] = 49,
            }),
            ElasticsearchConnection = new Elasticstack.Inputs.ElasticsearchSecurityUserElasticsearchConnectionArgs
            {
                Endpoints = new[]
                {
                    "http://localhost:9200",
                },
                Username = "elastic",
                Password = "changeme",
            },
        });
    
        var dev = new Elasticstack.ElasticsearchSecurityUser("dev", new()
        {
            Username = "devuser",
            Password = "1234567890",
            Roles = new[]
            {
                "kibana_user",
            },
            Metadata = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["env"] = "testing",
                ["open"] = false,
                ["number"] = 49,
            }),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.elasticstack.ElasticsearchSecurityUser;
    import com.pulumi.elasticstack.ElasticsearchSecurityUserArgs;
    import com.pulumi.elasticstack.inputs.ElasticsearchSecurityUserElasticsearchConnectionArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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 user = new ElasticsearchSecurityUser("user", ElasticsearchSecurityUserArgs.builder()
                .username("testuser")
                .passwordHash("$2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO")
                .roles("kibana_user")
                .metadata(serializeJson(
                    jsonObject(
                        jsonProperty("env", "testing"),
                        jsonProperty("open", false),
                        jsonProperty("number", 49)
                    )))
                .elasticsearchConnection(ElasticsearchSecurityUserElasticsearchConnectionArgs.builder()
                    .endpoints("http://localhost:9200")
                    .username("elastic")
                    .password("changeme")
                    .build())
                .build());
    
            var dev = new ElasticsearchSecurityUser("dev", ElasticsearchSecurityUserArgs.builder()
                .username("devuser")
                .password("1234567890")
                .roles("kibana_user")
                .metadata(serializeJson(
                    jsonObject(
                        jsonProperty("env", "testing"),
                        jsonProperty("open", false),
                        jsonProperty("number", 49)
                    )))
                .build());
    
        }
    }
    
    resources:
      user:
        type: elasticstack:ElasticsearchSecurityUser
        properties:
          username: testuser
          # use hashed password: see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-request-body
          passwordHash: $2a$10$rMZe6TdsUwBX/TA8vRDz0OLwKAZeCzXM4jT3tfCjpSTB8HoFuq8xO
          roles:
            - kibana_user
          # set the custom metadata for this user
          metadata:
            fn::toJSON:
              env: testing
              open: false
              number: 49
          elasticsearchConnection:
            endpoints:
              - http://localhost:9200
            username: elastic
            password: changeme
      dev:
        type: elasticstack:ElasticsearchSecurityUser
        properties:
          username: devuser
          password: '1234567890'
          roles:
            - kibana_user
          # set the custom metadata for this user
          metadata:
            fn::toJSON:
              env: testing
              open: false
              number: 49
    

    Create ElasticsearchSecurityUser Resource

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

    Constructor syntax

    new ElasticsearchSecurityUser(name: string, args: ElasticsearchSecurityUserArgs, opts?: CustomResourceOptions);
    @overload
    def ElasticsearchSecurityUser(resource_name: str,
                                  args: ElasticsearchSecurityUserArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ElasticsearchSecurityUser(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  roles: Optional[Sequence[str]] = None,
                                  username: Optional[str] = None,
                                  elasticsearch_connection: Optional[ElasticsearchSecurityUserElasticsearchConnectionArgs] = None,
                                  email: Optional[str] = None,
                                  enabled: Optional[bool] = None,
                                  full_name: Optional[str] = None,
                                  metadata: Optional[str] = None,
                                  password: Optional[str] = None,
                                  password_hash: Optional[str] = None)
    func NewElasticsearchSecurityUser(ctx *Context, name string, args ElasticsearchSecurityUserArgs, opts ...ResourceOption) (*ElasticsearchSecurityUser, error)
    public ElasticsearchSecurityUser(string name, ElasticsearchSecurityUserArgs args, CustomResourceOptions? opts = null)
    public ElasticsearchSecurityUser(String name, ElasticsearchSecurityUserArgs args)
    public ElasticsearchSecurityUser(String name, ElasticsearchSecurityUserArgs args, CustomResourceOptions options)
    
    type: elasticstack:ElasticsearchSecurityUser
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ElasticsearchSecurityUserArgs
    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 ElasticsearchSecurityUserArgs
    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 ElasticsearchSecurityUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticsearchSecurityUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticsearchSecurityUserArgs
    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 elasticsearchSecurityUserResource = new Elasticstack.ElasticsearchSecurityUser("elasticsearchSecurityUserResource", new()
    {
        Roles = new[]
        {
            "string",
        },
        Username = "string",
        Email = "string",
        Enabled = false,
        FullName = "string",
        Metadata = "string",
        Password = "string",
        PasswordHash = "string",
    });
    
    example, err := elasticstack.NewElasticsearchSecurityUser(ctx, "elasticsearchSecurityUserResource", &elasticstack.ElasticsearchSecurityUserArgs{
    	Roles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Username:     pulumi.String("string"),
    	Email:        pulumi.String("string"),
    	Enabled:      pulumi.Bool(false),
    	FullName:     pulumi.String("string"),
    	Metadata:     pulumi.String("string"),
    	Password:     pulumi.String("string"),
    	PasswordHash: pulumi.String("string"),
    })
    
    var elasticsearchSecurityUserResource = new ElasticsearchSecurityUser("elasticsearchSecurityUserResource", ElasticsearchSecurityUserArgs.builder()
        .roles("string")
        .username("string")
        .email("string")
        .enabled(false)
        .fullName("string")
        .metadata("string")
        .password("string")
        .passwordHash("string")
        .build());
    
    elasticsearch_security_user_resource = elasticstack.ElasticsearchSecurityUser("elasticsearchSecurityUserResource",
        roles=["string"],
        username="string",
        email="string",
        enabled=False,
        full_name="string",
        metadata="string",
        password="string",
        password_hash="string")
    
    const elasticsearchSecurityUserResource = new elasticstack.ElasticsearchSecurityUser("elasticsearchSecurityUserResource", {
        roles: ["string"],
        username: "string",
        email: "string",
        enabled: false,
        fullName: "string",
        metadata: "string",
        password: "string",
        passwordHash: "string",
    });
    
    type: elasticstack:ElasticsearchSecurityUser
    properties:
        email: string
        enabled: false
        fullName: string
        metadata: string
        password: string
        passwordHash: string
        roles:
            - string
        username: string
    

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

    Roles List<string>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    Username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    ElasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    Email string
    The email of the user.
    Enabled bool
    Specifies whether the user is enabled. The default value is true.
    FullName string
    The full name of the user.
    Metadata string
    Arbitrary metadata that you want to associate with the user.
    Password string
    The user’s password. Passwords must be at least 6 characters long.
    PasswordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    Roles []string
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    Username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    ElasticsearchConnection ElasticsearchSecurityUserElasticsearchConnectionArgs
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    Email string
    The email of the user.
    Enabled bool
    Specifies whether the user is enabled. The default value is true.
    FullName string
    The full name of the user.
    Metadata string
    Arbitrary metadata that you want to associate with the user.
    Password string
    The user’s password. Passwords must be at least 6 characters long.
    PasswordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles List<String>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username String
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email String
    The email of the user.
    enabled Boolean
    Specifies whether the user is enabled. The default value is true.
    fullName String
    The full name of the user.
    metadata String
    Arbitrary metadata that you want to associate with the user.
    password String
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash String
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles string[]
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email string
    The email of the user.
    enabled boolean
    Specifies whether the user is enabled. The default value is true.
    fullName string
    The full name of the user.
    metadata string
    Arbitrary metadata that you want to associate with the user.
    password string
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles Sequence[str]
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username str
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearch_connection ElasticsearchSecurityUserElasticsearchConnectionArgs
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email str
    The email of the user.
    enabled bool
    Specifies whether the user is enabled. The default value is true.
    full_name str
    The full name of the user.
    metadata str
    Arbitrary metadata that you want to associate with the user.
    password str
    The user’s password. Passwords must be at least 6 characters long.
    password_hash str
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles List<String>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username String
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection Property Map
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email String
    The email of the user.
    enabled Boolean
    Specifies whether the user is enabled. The default value is true.
    fullName String
    The full name of the user.
    metadata String
    Arbitrary metadata that you want to associate with the user.
    password String
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash String
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ElasticsearchSecurityUser 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ElasticsearchSecurityUser Resource

    Get an existing ElasticsearchSecurityUser 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?: ElasticsearchSecurityUserState, opts?: CustomResourceOptions): ElasticsearchSecurityUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            elasticsearch_connection: Optional[ElasticsearchSecurityUserElasticsearchConnectionArgs] = None,
            email: Optional[str] = None,
            enabled: Optional[bool] = None,
            full_name: Optional[str] = None,
            metadata: Optional[str] = None,
            password: Optional[str] = None,
            password_hash: Optional[str] = None,
            roles: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> ElasticsearchSecurityUser
    func GetElasticsearchSecurityUser(ctx *Context, name string, id IDInput, state *ElasticsearchSecurityUserState, opts ...ResourceOption) (*ElasticsearchSecurityUser, error)
    public static ElasticsearchSecurityUser Get(string name, Input<string> id, ElasticsearchSecurityUserState? state, CustomResourceOptions? opts = null)
    public static ElasticsearchSecurityUser get(String name, Output<String> id, ElasticsearchSecurityUserState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:ElasticsearchSecurityUser    get:      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:
    ElasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    Email string
    The email of the user.
    Enabled bool
    Specifies whether the user is enabled. The default value is true.
    FullName string
    The full name of the user.
    Metadata string
    Arbitrary metadata that you want to associate with the user.
    Password string
    The user’s password. Passwords must be at least 6 characters long.
    PasswordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    Roles List<string>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    Username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    ElasticsearchConnection ElasticsearchSecurityUserElasticsearchConnectionArgs
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    Email string
    The email of the user.
    Enabled bool
    Specifies whether the user is enabled. The default value is true.
    FullName string
    The full name of the user.
    Metadata string
    Arbitrary metadata that you want to associate with the user.
    Password string
    The user’s password. Passwords must be at least 6 characters long.
    PasswordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    Roles []string
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    Username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email String
    The email of the user.
    enabled Boolean
    Specifies whether the user is enabled. The default value is true.
    fullName String
    The full name of the user.
    metadata String
    Arbitrary metadata that you want to associate with the user.
    password String
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash String
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles List<String>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username String
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection ElasticsearchSecurityUserElasticsearchConnection
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email string
    The email of the user.
    enabled boolean
    Specifies whether the user is enabled. The default value is true.
    fullName string
    The full name of the user.
    metadata string
    Arbitrary metadata that you want to associate with the user.
    password string
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash string
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles string[]
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username string
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearch_connection ElasticsearchSecurityUserElasticsearchConnectionArgs
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email str
    The email of the user.
    enabled bool
    Specifies whether the user is enabled. The default value is true.
    full_name str
    The full name of the user.
    metadata str
    Arbitrary metadata that you want to associate with the user.
    password str
    The user’s password. Passwords must be at least 6 characters long.
    password_hash str
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles Sequence[str]
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username str
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).
    elasticsearchConnection Property Map
    Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

    Deprecated: Deprecated

    email String
    The email of the user.
    enabled Boolean
    Specifies whether the user is enabled. The default value is true.
    fullName String
    The full name of the user.
    metadata String
    Arbitrary metadata that you want to associate with the user.
    password String
    The user’s password. Passwords must be at least 6 characters long.
    passwordHash String
    A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings).
    roles List<String>
    A set of roles the user has. The roles determine the user’s access permissions. Default is [].
    username String
    An identifier for the user (see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html#security-api-put-user-path-params).

    Supporting Types

    ElasticsearchSecurityUserElasticsearchConnection, ElasticsearchSecurityUserElasticsearchConnectionArgs

    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints List<string>
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints []string
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.
    apiKey string
    API Key to use for authentication to Elasticsearch
    bearerToken string
    Bearer Token to use for authentication to Elasticsearch
    caData string
    PEM-encoded custom Certificate Authority certificate
    caFile string
    Path to a custom Certificate Authority certificate
    certData string
    PEM encoded certificate for client auth
    certFile string
    Path to a file containing the PEM encoded certificate for client auth
    endpoints string[]
    esClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    insecure boolean
    Disable TLS certificate validation
    keyData string
    PEM encoded private key for client auth
    keyFile string
    Path to a file containing the PEM encoded private key for client auth
    password string
    Password to use for API authentication to Elasticsearch.
    username string
    Username to use for API authentication to Elasticsearch.
    api_key str
    API Key to use for authentication to Elasticsearch
    bearer_token str
    Bearer Token to use for authentication to Elasticsearch
    ca_data str
    PEM-encoded custom Certificate Authority certificate
    ca_file str
    Path to a custom Certificate Authority certificate
    cert_data str
    PEM encoded certificate for client auth
    cert_file str
    Path to a file containing the PEM encoded certificate for client auth
    endpoints Sequence[str]
    es_client_authentication str
    ES Client Authentication field to be used with the JWT token
    insecure bool
    Disable TLS certificate validation
    key_data str
    PEM encoded private key for client auth
    key_file str
    Path to a file containing the PEM encoded private key for client auth
    password str
    Password to use for API authentication to Elasticsearch.
    username str
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.

    Import

    $ pulumi import elasticstack:index/elasticsearchSecurityUser:ElasticsearchSecurityUser user <cluster_uuid>/<user-name>
    

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

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic