Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. KibanaSecurityRole
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

elasticstack.KibanaSecurityRole

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

    Creates or updates a Kibana role. See https://www.elastic.co/guide/en/kibana/master/role-management-api-put.html

    For Features, see: https://www.elastic.co/guide/en/kibana/current/features-api-get.html

    For Security Privileges, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html

    Example Usage

    Using base privileges

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSecurityRole;
import com.pulumi.elasticstack.KibanaSecurityRoleArgs;
import com.pulumi.elasticstack.inputs.KibanaSecurityRoleElasticsearchArgs;
import com.pulumi.elasticstack.inputs.KibanaSecurityRoleKibanaArgs;
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 example = new KibanaSecurityRole("example", KibanaSecurityRoleArgs.builder()
            .elasticsearch(KibanaSecurityRoleElasticsearchArgs.builder()
                .clusters("create_snapshot")
                .indices(KibanaSecurityRoleElasticsearchIndexArgs.builder()
                    .fieldSecurity(KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs.builder()
                        .except()
                        .grant("test")
                        .build())
                    .names("test")
                    .privileges(                    
                        "create",
                        "read",
                        "write")
                    .build())
                .remoteIndices(KibanaSecurityRoleElasticsearchRemoteIndexArgs.builder()
                    .clusters("test-cluster")
                    .fieldSecurity(KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs.builder()
                        .except()
                        .grant("test")
                        .build())
                    .names("test")
                    .privileges(                    
                        "create",
                        "read",
                        "write")
                    .build())
                .build())
            .kibanas(KibanaSecurityRoleKibanaArgs.builder()
                .bases("all")
                .spaces("default")
                .build())
            .build());

    }
}

    resources:
  example:
    type: elasticstack:KibanaSecurityRole
    properties:
      elasticsearch:
        clusters:
          - create_snapshot
        indices:
          - fieldSecurity:
              except: []
              grant:
                - test
            names:
              - test
            privileges:
              - create
              - read
              - write
        remoteIndices:
          - clusters:
              - test-cluster
            fieldSecurity:
              except: []
              grant:
                - test
            names:
              - test
            privileges:
              - create
              - read
              - write
      kibanas:
        - bases:
            - all
          spaces:
            - default

    Using feature privileges

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSecurityRole;
import com.pulumi.elasticstack.KibanaSecurityRoleArgs;
import com.pulumi.elasticstack.inputs.KibanaSecurityRoleElasticsearchArgs;
import com.pulumi.elasticstack.inputs.KibanaSecurityRoleKibanaArgs;
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 example = new KibanaSecurityRole("example", KibanaSecurityRoleArgs.builder()
            .elasticsearch(KibanaSecurityRoleElasticsearchArgs.builder()
                .clusters("create_snapshot")
                .indices(KibanaSecurityRoleElasticsearchIndexArgs.builder()
                    .fieldSecurity(KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs.builder()
                        .except()
                        .grant("test")
                        .build())
                    .names("test")
                    .privileges(                    
                        "create",
                        "read",
                        "write")
                    .build())
                .remoteIndices(KibanaSecurityRoleElasticsearchRemoteIndexArgs.builder()
                    .clusters("test-cluster")
                    .fieldSecurity(KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs.builder()
                        .except()
                        .grant("test")
                        .build())
                    .names("test")
                    .privileges(                    
                        "create",
                        "read",
                        "write")
                    .build())
                .build())
            .kibanas(KibanaSecurityRoleKibanaArgs.builder()
                .features(                
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("actions")
                        .privileges("read")
                        .build(),
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("discover")
                        .privileges(                        
                            "minimal_read",
                            "url_create",
                            "store_search_session")
                        .build(),
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("observabilityCases")
                        .privileges(                        
                            "minimal_read",
                            "cases_delete")
                        .build(),
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("osquery")
                        .privileges(                        
                            "minimal_read",
                            "live_queries_all",
                            "run_saved_queries",
                            "saved_queries_read",
                            "packs_all")
                        .build(),
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("rulesSettings")
                        .privileges(                        
                            "minimal_read",
                            "readFlappingSettings")
                        .build(),
                    KibanaSecurityRoleKibanaFeatureArgs.builder()
                        .name("securitySolutionCases")
                        .privileges(                        
                            "minimal_read",
                            "cases_delete")
                        .build())
                .spaces("default")
                .build())
            .build());

    }
}

    resources:
  example:
    type: elasticstack:KibanaSecurityRole
    properties:
      elasticsearch:
        clusters:
          - create_snapshot
        indices:
          - fieldSecurity:
              except: []
              grant:
                - test
            names:
              - test
            privileges:
              - create
              - read
              - write
        remoteIndices:
          - clusters:
              - test-cluster
            fieldSecurity:
              except: []
              grant:
                - test
            names:
              - test
            privileges:
              - create
              - read
              - write
      kibanas:
        - features:
            - name: actions
              privileges:
                - read
            - name: discover
              privileges:
                - minimal_read
                - url_create
                - store_search_session
            - name: observabilityCases
              privileges:
                - minimal_read
                - cases_delete
            - name: osquery
              privileges:
                - minimal_read
                - live_queries_all
                - run_saved_queries
                - saved_queries_read
                - packs_all
            - name: rulesSettings
              privileges:
                - minimal_read
                - readFlappingSettings
            - name: securitySolutionCases
              privileges:
                - minimal_read
                - cases_delete
          spaces:
            - default

    Create KibanaSecurityRole Resource

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

    Constructor syntax

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

@overload
def KibanaSecurityRole(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       elasticsearch: Optional[KibanaSecurityRoleElasticsearchArgs] = None,
                       kibana_security_role_id: Optional[str] = None,
                       kibanas: Optional[Sequence[KibanaSecurityRoleKibanaArgs]] = None,
                       metadata: Optional[str] = None,
                       name: Optional[str] = None)
    func NewKibanaSecurityRole(ctx *Context, name string, args KibanaSecurityRoleArgs, opts ...ResourceOption) (*KibanaSecurityRole, error)
    public KibanaSecurityRole(string name, KibanaSecurityRoleArgs args, CustomResourceOptions? opts = null)
    public KibanaSecurityRole(String name, KibanaSecurityRoleArgs args)
public KibanaSecurityRole(String name, KibanaSecurityRoleArgs args, CustomResourceOptions options)

    type: elasticstack:KibanaSecurityRole
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 KibanaSecurityRoleArgs
    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 KibanaSecurityRoleArgs
    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 KibanaSecurityRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KibanaSecurityRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KibanaSecurityRoleArgs
    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 kibanaSecurityRoleResource = new Elasticstack.KibanaSecurityRole("kibanaSecurityRoleResource", new()
{
    Elasticsearch = new Elasticstack.Inputs.KibanaSecurityRoleElasticsearchArgs
    {
        Clusters = new[]
        {
            "string",
        },
        Indices = new[]
        {
            new Elasticstack.Inputs.KibanaSecurityRoleElasticsearchIndexArgs
            {
                Names = new[]
                {
                    "string",
                },
                Privileges = new[]
                {
                    "string",
                },
                FieldSecurity = new Elasticstack.Inputs.KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs
                {
                    Excepts = new[]
                    {
                        "string",
                    },
                    Grants = new[]
                    {
                        "string",
                    },
                },
                Query = "string",
            },
        },
        RemoteIndices = new[]
        {
            new Elasticstack.Inputs.KibanaSecurityRoleElasticsearchRemoteIndexArgs
            {
                Clusters = new[]
                {
                    "string",
                },
                Names = new[]
                {
                    "string",
                },
                Privileges = new[]
                {
                    "string",
                },
                FieldSecurity = new Elasticstack.Inputs.KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs
                {
                    Excepts = new[]
                    {
                        "string",
                    },
                    Grants = new[]
                    {
                        "string",
                    },
                },
                Query = "string",
            },
        },
        RunAs = new[]
        {
            "string",
        },
    },
    KibanaSecurityRoleId = "string",
    Kibanas = new[]
    {
        new Elasticstack.Inputs.KibanaSecurityRoleKibanaArgs
        {
            Spaces = new[]
            {
                "string",
            },
            Bases = new[]
            {
                "string",
            },
            Features = new[]
            {
                new Elasticstack.Inputs.KibanaSecurityRoleKibanaFeatureArgs
                {
                    Name = "string",
                    Privileges = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    Metadata = "string",
    Name = "string",
});

    example, err := elasticstack.NewKibanaSecurityRole(ctx, "kibanaSecurityRoleResource", &elasticstack.KibanaSecurityRoleArgs{
	Elasticsearch: &elasticstack.KibanaSecurityRoleElasticsearchArgs{
		Clusters: pulumi.StringArray{
			pulumi.String("string"),
		},
		Indices: elasticstack.KibanaSecurityRoleElasticsearchIndexArray{
			&elasticstack.KibanaSecurityRoleElasticsearchIndexArgs{
				Names: pulumi.StringArray{
					pulumi.String("string"),
				},
				Privileges: pulumi.StringArray{
					pulumi.String("string"),
				},
				FieldSecurity: &elasticstack.KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs{
					Excepts: pulumi.StringArray{
						pulumi.String("string"),
					},
					Grants: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				Query: pulumi.String("string"),
			},
		},
		RemoteIndices: elasticstack.KibanaSecurityRoleElasticsearchRemoteIndexArray{
			&elasticstack.KibanaSecurityRoleElasticsearchRemoteIndexArgs{
				Clusters: pulumi.StringArray{
					pulumi.String("string"),
				},
				Names: pulumi.StringArray{
					pulumi.String("string"),
				},
				Privileges: pulumi.StringArray{
					pulumi.String("string"),
				},
				FieldSecurity: &elasticstack.KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs{
					Excepts: pulumi.StringArray{
						pulumi.String("string"),
					},
					Grants: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				Query: pulumi.String("string"),
			},
		},
		RunAs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	KibanaSecurityRoleId: pulumi.String("string"),
	Kibanas: elasticstack.KibanaSecurityRoleKibanaArray{
		&elasticstack.KibanaSecurityRoleKibanaArgs{
			Spaces: pulumi.StringArray{
				pulumi.String("string"),
			},
			Bases: pulumi.StringArray{
				pulumi.String("string"),
			},
			Features: elasticstack.KibanaSecurityRoleKibanaFeatureArray{
				&elasticstack.KibanaSecurityRoleKibanaFeatureArgs{
					Name: pulumi.String("string"),
					Privileges: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	Metadata: pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var kibanaSecurityRoleResource = new KibanaSecurityRole("kibanaSecurityRoleResource", KibanaSecurityRoleArgs.builder()
    .elasticsearch(KibanaSecurityRoleElasticsearchArgs.builder()
        .clusters("string")
        .indices(KibanaSecurityRoleElasticsearchIndexArgs.builder()
            .names("string")
            .privileges("string")
            .fieldSecurity(KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs.builder()
                .excepts("string")
                .grants("string")
                .build())
            .query("string")
            .build())
        .remoteIndices(KibanaSecurityRoleElasticsearchRemoteIndexArgs.builder()
            .clusters("string")
            .names("string")
            .privileges("string")
            .fieldSecurity(KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs.builder()
                .excepts("string")
                .grants("string")
                .build())
            .query("string")
            .build())
        .runAs("string")
        .build())
    .kibanaSecurityRoleId("string")
    .kibanas(KibanaSecurityRoleKibanaArgs.builder()
        .spaces("string")
        .bases("string")
        .features(KibanaSecurityRoleKibanaFeatureArgs.builder()
            .name("string")
            .privileges("string")
            .build())
        .build())
    .metadata("string")
    .name("string")
    .build());

    kibana_security_role_resource = elasticstack.KibanaSecurityRole("kibanaSecurityRoleResource",
    elasticsearch={
        "clusters": ["string"],
        "indices": [{
            "names": ["string"],
            "privileges": ["string"],
            "field_security": {
                "excepts": ["string"],
                "grants": ["string"],
            },
            "query": "string",
        }],
        "remote_indices": [{
            "clusters": ["string"],
            "names": ["string"],
            "privileges": ["string"],
            "field_security": {
                "excepts": ["string"],
                "grants": ["string"],
            },
            "query": "string",
        }],
        "run_as": ["string"],
    },
    kibana_security_role_id="string",
    kibanas=[{
        "spaces": ["string"],
        "bases": ["string"],
        "features": [{
            "name": "string",
            "privileges": ["string"],
        }],
    }],
    metadata="string",
    name="string")

    const kibanaSecurityRoleResource = new elasticstack.KibanaSecurityRole("kibanaSecurityRoleResource", {
    elasticsearch: {
        clusters: ["string"],
        indices: [{
            names: ["string"],
            privileges: ["string"],
            fieldSecurity: {
                excepts: ["string"],
                grants: ["string"],
            },
            query: "string",
        }],
        remoteIndices: [{
            clusters: ["string"],
            names: ["string"],
            privileges: ["string"],
            fieldSecurity: {
                excepts: ["string"],
                grants: ["string"],
            },
            query: "string",
        }],
        runAs: ["string"],
    },
    kibanaSecurityRoleId: "string",
    kibanas: [{
        spaces: ["string"],
        bases: ["string"],
        features: [{
            name: "string",
            privileges: ["string"],
        }],
    }],
    metadata: "string",
    name: "string",
});

    type: elasticstack:KibanaSecurityRole
properties:
    elasticsearch:
        clusters:
            - string
        indices:
            - fieldSecurity:
                excepts:
                    - string
                grants:
                    - string
              names:
                - string
              privileges:
                - string
              query: string
        remoteIndices:
            - clusters:
                - string
              fieldSecurity:
                excepts:
                    - string
                grants:
                    - string
              names:
                - string
              privileges:
                - string
              query: string
        runAs:
            - string
    kibanaSecurityRoleId: string
    kibanas:
        - bases:
            - string
          features:
            - name: string
              privileges:
                - string
          spaces:
            - string
    metadata: string
    name: string

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

    Elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    KibanaSecurityRoleId string
    The ID of this resource.
    Kibanas List<KibanaSecurityRoleKibana>
    The list of objects that specify the Kibana privileges for the role.
    Metadata string
    Optional meta-data.
    Name string
    The name for the role.
    Elasticsearch KibanaSecurityRoleElasticsearchArgs
    Elasticsearch cluster and index privileges.
    KibanaSecurityRoleId string
    The ID of this resource.
    Kibanas []KibanaSecurityRoleKibanaArgs
    The list of objects that specify the Kibana privileges for the role.
    Metadata string
    Optional meta-data.
    Name string
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId String
    The ID of this resource.
    kibanas List<KibanaSecurityRoleKibana>
    The list of objects that specify the Kibana privileges for the role.
    metadata String
    Optional meta-data.
    name String
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId string
    The ID of this resource.
    kibanas KibanaSecurityRoleKibana[]
    The list of objects that specify the Kibana privileges for the role.
    metadata string
    Optional meta-data.
    name string
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearchArgs
    Elasticsearch cluster and index privileges.
    kibana_security_role_id str
    The ID of this resource.
    kibanas Sequence[KibanaSecurityRoleKibanaArgs]
    The list of objects that specify the Kibana privileges for the role.
    metadata str
    Optional meta-data.
    name str
    The name for the role.
    elasticsearch Property Map
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId String
    The ID of this resource.
    kibanas List<Property Map>
    The list of objects that specify the Kibana privileges for the role.
    metadata String
    Optional meta-data.
    name String
    The name for the role.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KibanaSecurityRole 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 KibanaSecurityRole Resource

    Get an existing KibanaSecurityRole 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?: KibanaSecurityRoleState, opts?: CustomResourceOptions): KibanaSecurityRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        elasticsearch: Optional[KibanaSecurityRoleElasticsearchArgs] = None,
        kibana_security_role_id: Optional[str] = None,
        kibanas: Optional[Sequence[KibanaSecurityRoleKibanaArgs]] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None) -> KibanaSecurityRole
    func GetKibanaSecurityRole(ctx *Context, name string, id IDInput, state *KibanaSecurityRoleState, opts ...ResourceOption) (*KibanaSecurityRole, error)
    public static KibanaSecurityRole Get(string name, Input<string> id, KibanaSecurityRoleState? state, CustomResourceOptions? opts = null)
    public static KibanaSecurityRole get(String name, Output<String> id, KibanaSecurityRoleState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:KibanaSecurityRole    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:
    Elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    KibanaSecurityRoleId string
    The ID of this resource.
    Kibanas List<KibanaSecurityRoleKibana>
    The list of objects that specify the Kibana privileges for the role.
    Metadata string
    Optional meta-data.
    Name string
    The name for the role.
    Elasticsearch KibanaSecurityRoleElasticsearchArgs
    Elasticsearch cluster and index privileges.
    KibanaSecurityRoleId string
    The ID of this resource.
    Kibanas []KibanaSecurityRoleKibanaArgs
    The list of objects that specify the Kibana privileges for the role.
    Metadata string
    Optional meta-data.
    Name string
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId String
    The ID of this resource.
    kibanas List<KibanaSecurityRoleKibana>
    The list of objects that specify the Kibana privileges for the role.
    metadata String
    Optional meta-data.
    name String
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearch
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId string
    The ID of this resource.
    kibanas KibanaSecurityRoleKibana[]
    The list of objects that specify the Kibana privileges for the role.
    metadata string
    Optional meta-data.
    name string
    The name for the role.
    elasticsearch KibanaSecurityRoleElasticsearchArgs
    Elasticsearch cluster and index privileges.
    kibana_security_role_id str
    The ID of this resource.
    kibanas Sequence[KibanaSecurityRoleKibanaArgs]
    The list of objects that specify the Kibana privileges for the role.
    metadata str
    Optional meta-data.
    name str
    The name for the role.
    elasticsearch Property Map
    Elasticsearch cluster and index privileges.
    kibanaSecurityRoleId String
    The ID of this resource.
    kibanas List<Property Map>
    The list of objects that specify the Kibana privileges for the role.
    metadata String
    Optional meta-data.
    name String
    The name for the role.

    Supporting Types

    KibanaSecurityRoleElasticsearch, KibanaSecurityRoleElasticsearchArgs

    Clusters List<string>
    List of the cluster privileges.
    Indices List<KibanaSecurityRoleElasticsearchIndex>
    A list of indices permissions entries.
    RemoteIndices List<KibanaSecurityRoleElasticsearchRemoteIndex>
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    RunAs List<string>
    A list of usernames the owners of this role can impersonate.
    Clusters []string
    List of the cluster privileges.
    Indices []KibanaSecurityRoleElasticsearchIndex
    A list of indices permissions entries.
    RemoteIndices []KibanaSecurityRoleElasticsearchRemoteIndex
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    RunAs []string
    A list of usernames the owners of this role can impersonate.
    clusters List<String>
    List of the cluster privileges.
    indices List<KibanaSecurityRoleElasticsearchIndex>
    A list of indices permissions entries.
    remoteIndices List<KibanaSecurityRoleElasticsearchRemoteIndex>
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    runAs List<String>
    A list of usernames the owners of this role can impersonate.
    clusters string[]
    List of the cluster privileges.
    indices KibanaSecurityRoleElasticsearchIndex[]
    A list of indices permissions entries.
    remoteIndices KibanaSecurityRoleElasticsearchRemoteIndex[]
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    runAs string[]
    A list of usernames the owners of this role can impersonate.
    clusters Sequence[str]
    List of the cluster privileges.
    indices Sequence[KibanaSecurityRoleElasticsearchIndex]
    A list of indices permissions entries.
    remote_indices Sequence[KibanaSecurityRoleElasticsearchRemoteIndex]
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    run_as Sequence[str]
    A list of usernames the owners of this role can impersonate.
    clusters List<String>
    List of the cluster privileges.
    indices List<Property Map>
    A list of indices permissions entries.
    remoteIndices List<Property Map>
    A list of remote indices permissions entries. Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model.
    runAs List<String>
    A list of usernames the owners of this role can impersonate.

    KibanaSecurityRoleElasticsearchIndex, KibanaSecurityRoleElasticsearchIndexArgs

    Names List<string>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    Privileges List<string>
    The index level privileges that the owners of the role have on the specified indices.
    FieldSecurity KibanaSecurityRoleElasticsearchIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    Query string
    A search query that defines the documents the owners of the role have read access to.
    Names []string
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    Privileges []string
    The index level privileges that the owners of the role have on the specified indices.
    FieldSecurity KibanaSecurityRoleElasticsearchIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    Query string
    A search query that defines the documents the owners of the role have read access to.
    names List<String>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges List<String>
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity KibanaSecurityRoleElasticsearchIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query String
    A search query that defines the documents the owners of the role have read access to.
    names string[]
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges string[]
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity KibanaSecurityRoleElasticsearchIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query string
    A search query that defines the documents the owners of the role have read access to.
    names Sequence[str]
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges Sequence[str]
    The index level privileges that the owners of the role have on the specified indices.
    field_security KibanaSecurityRoleElasticsearchIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query str
    A search query that defines the documents the owners of the role have read access to.
    names List<String>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges List<String>
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity Property Map
    The document fields that the owners of the role have read access to.
    query String
    A search query that defines the documents the owners of the role have read access to.

    KibanaSecurityRoleElasticsearchIndexFieldSecurity, KibanaSecurityRoleElasticsearchIndexFieldSecurityArgs

    Excepts List<string>
    List of the fields to which the grants will not be applied.
    Grants List<string>
    List of the fields to grant the access to.
    Excepts []string
    List of the fields to which the grants will not be applied.
    Grants []string
    List of the fields to grant the access to.
    excepts List<String>
    List of the fields to which the grants will not be applied.
    grants List<String>
    List of the fields to grant the access to.
    excepts string[]
    List of the fields to which the grants will not be applied.
    grants string[]
    List of the fields to grant the access to.
    excepts Sequence[str]
    List of the fields to which the grants will not be applied.
    grants Sequence[str]
    List of the fields to grant the access to.
    excepts List<String>
    List of the fields to which the grants will not be applied.
    grants List<String>
    List of the fields to grant the access to.

    KibanaSecurityRoleElasticsearchRemoteIndex, KibanaSecurityRoleElasticsearchRemoteIndexArgs

    Clusters List<string>
    A list of cluster aliases to which the permissions in this entry apply.
    Names List<string>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    Privileges List<string>
    The index level privileges that the owners of the role have on the specified indices.
    FieldSecurity KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    Query string
    A search query that defines the documents the owners of the role have read access to.
    Clusters []string
    A list of cluster aliases to which the permissions in this entry apply.
    Names []string
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    Privileges []string
    The index level privileges that the owners of the role have on the specified indices.
    FieldSecurity KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    Query string
    A search query that defines the documents the owners of the role have read access to.
    clusters List<String>
    A list of cluster aliases to which the permissions in this entry apply.
    names List<String>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges List<String>
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query String
    A search query that defines the documents the owners of the role have read access to.
    clusters string[]
    A list of cluster aliases to which the permissions in this entry apply.
    names string[]
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges string[]
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query string
    A search query that defines the documents the owners of the role have read access to.
    clusters Sequence[str]
    A list of cluster aliases to which the permissions in this entry apply.
    names Sequence[str]
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges Sequence[str]
    The index level privileges that the owners of the role have on the specified indices.
    field_security KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
    The document fields that the owners of the role have read access to.
    query str
    A search query that defines the documents the owners of the role have read access to.
    clusters List<String>
    A list of cluster aliases to which the permissions in this entry apply.
    names List<String>
    A list of indices (or index name patterns) to which the permissions in this entry apply.
    privileges List<String>
    The index level privileges that the owners of the role have on the specified indices.
    fieldSecurity Property Map
    The document fields that the owners of the role have read access to.
    query String
    A search query that defines the documents the owners of the role have read access to.

    KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity, KibanaSecurityRoleElasticsearchRemoteIndexFieldSecurityArgs

    Excepts List<string>
    List of the fields to which the grants will not be applied.
    Grants List<string>
    List of the fields to grant the access to.
    Excepts []string
    List of the fields to which the grants will not be applied.
    Grants []string
    List of the fields to grant the access to.
    excepts List<String>
    List of the fields to which the grants will not be applied.
    grants List<String>
    List of the fields to grant the access to.
    excepts string[]
    List of the fields to which the grants will not be applied.
    grants string[]
    List of the fields to grant the access to.
    excepts Sequence[str]
    List of the fields to which the grants will not be applied.
    grants Sequence[str]
    List of the fields to grant the access to.
    excepts List<String>
    List of the fields to which the grants will not be applied.
    grants List<String>
    List of the fields to grant the access to.

    KibanaSecurityRoleKibana, KibanaSecurityRoleKibanaArgs

    Spaces List<string>
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    Bases List<string>
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    Features List<KibanaSecurityRoleKibanaFeature>
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.
    Spaces []string
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    Bases []string
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    Features []KibanaSecurityRoleKibanaFeature
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.
    spaces List<String>
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    bases List<String>
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    features List<KibanaSecurityRoleKibanaFeature>
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.
    spaces string[]
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    bases string[]
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    features KibanaSecurityRoleKibanaFeature[]
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.
    spaces Sequence[str]
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    bases Sequence[str]
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    features Sequence[KibanaSecurityRoleKibanaFeature]
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.
    spaces List<String>
    The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
    bases List<String>
    A base privilege. When specified, the base must be ["all"] or ["read"]. When the base privileges are specified, you are unable to use the "feature" section.
    features List<Property Map>
    List of privileges for specific features. When the feature privileges are specified, you are unable to use the "base" section.

    KibanaSecurityRoleKibanaFeature, KibanaSecurityRoleKibanaFeatureArgs

    Name string
    Feature name.
    Privileges List<string>
    Feature privileges.
    Name string
    Feature name.
    Privileges []string
    Feature privileges.
    name String
    Feature name.
    privileges List<String>
    Feature privileges.
    name string
    Feature name.
    privileges string[]
    Feature privileges.
    name str
    Feature name.
    privileges Sequence[str]
    Feature privileges.
    name String
    Feature name.
    privileges List<String>
    Feature privileges.

    Import

    $ pulumi import elasticstack:index/kibanaSecurityRole:KibanaSecurityRole example_role <role 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
    elastic/terraform-provider-elasticstack