Viewing docs for elasticstack 0.15.2
published on Tuesday, May 19, 2026 by elastic
published on Tuesday, May 19, 2026 by elastic
Viewing docs for elasticstack 0.15.2
published on Tuesday, May 19, 2026 by elastic
published on Tuesday, May 19, 2026 by elastic
Retrieve a specific role. See the role management API documentation for more details.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const example = elasticstack.getKibanaSecurityRole({
name: "sample_role",
});
import pulumi
import pulumi_elasticstack as elasticstack
example = elasticstack.get_kibana_security_role(name="sample_role")
package main
import (
"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 {
_, err := elasticstack.LookupKibanaSecurityRole(ctx, &elasticstack.LookupKibanaSecurityRoleArgs{
Name: "sample_role",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var example = Elasticstack.GetKibanaSecurityRole.Invoke(new()
{
Name = "sample_role",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetKibanaSecurityRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ElasticstackFunctions.getKibanaSecurityRole(GetKibanaSecurityRoleArgs.builder()
.name("sample_role")
.build());
}
}
variables:
example:
fn::invoke:
function: elasticstack:getKibanaSecurityRole
arguments:
name: sample_role
Example coming soon!
Using getKibanaSecurityRole
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getKibanaSecurityRole(args: GetKibanaSecurityRoleArgs, opts?: InvokeOptions): Promise<GetKibanaSecurityRoleResult>
function getKibanaSecurityRoleOutput(args: GetKibanaSecurityRoleOutputArgs, opts?: InvokeOptions): Output<GetKibanaSecurityRoleResult>def get_kibana_security_role(description: Optional[str] = None,
kibana_connections: Optional[Sequence[GetKibanaSecurityRoleKibanaConnection]] = None,
metadata: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKibanaSecurityRoleResult
def get_kibana_security_role_output(description: pulumi.Input[Optional[str]] = None,
kibana_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetKibanaSecurityRoleKibanaConnectionArgs]]]] = None,
metadata: pulumi.Input[Optional[str]] = None,
name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKibanaSecurityRoleResult]func LookupKibanaSecurityRole(ctx *Context, args *LookupKibanaSecurityRoleArgs, opts ...InvokeOption) (*LookupKibanaSecurityRoleResult, error)
func LookupKibanaSecurityRoleOutput(ctx *Context, args *LookupKibanaSecurityRoleOutputArgs, opts ...InvokeOption) LookupKibanaSecurityRoleResultOutput> Note: This function is named LookupKibanaSecurityRole in the Go SDK.
public static class GetKibanaSecurityRole
{
public static Task<GetKibanaSecurityRoleResult> InvokeAsync(GetKibanaSecurityRoleArgs args, InvokeOptions? opts = null)
public static Output<GetKibanaSecurityRoleResult> Invoke(GetKibanaSecurityRoleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKibanaSecurityRoleResult> getKibanaSecurityRole(GetKibanaSecurityRoleArgs args, InvokeOptions options)
public static Output<GetKibanaSecurityRoleResult> getKibanaSecurityRole(GetKibanaSecurityRoleArgs args, InvokeOptions options)
fn::invoke:
function: elasticstack:index/getKibanaSecurityRole:getKibanaSecurityRole
arguments:
# arguments dictionarydata "elasticstack_getkibanasecurityrole" "name" {
# arguments
}The following arguments are supported:
- Name string
- The name for the role.
- Description string
- Description for the role
- Kibana
Connections List<GetKibana Security Role Kibana Connection> - Kibana connection configuration block.
- Metadata string
- Optional meta-data.
- Name string
- The name for the role.
- Description string
- Description for the role
- Kibana
Connections []GetKibana Security Role Kibana Connection - Kibana connection configuration block.
- Metadata string
- Optional meta-data.
- name string
- The name for the role.
- description string
- Description for the role
- kibana_
connections list(object) - Kibana connection configuration block.
- metadata string
- Optional meta-data.
- name String
- The name for the role.
- description String
- Description for the role
- kibana
Connections List<GetKibana Security Role Kibana Connection> - Kibana connection configuration block.
- metadata String
- Optional meta-data.
- name string
- The name for the role.
- description string
- Description for the role
- kibana
Connections GetKibana Security Role Kibana Connection[] - Kibana connection configuration block.
- metadata string
- Optional meta-data.
- name str
- The name for the role.
- description str
- Description for the role
- kibana_
connections Sequence[GetKibana Security Role Kibana Connection] - Kibana connection configuration block.
- metadata str
- Optional meta-data.
- name String
- The name for the role.
- description String
- Description for the role
- kibana
Connections List<Property Map> - Kibana connection configuration block.
- metadata String
- Optional meta-data.
getKibanaSecurityRole Result
The following output properties are available:
- Description string
- Description for the role
- Elasticsearch
Get
Kibana Security Role Elasticsearch - Elasticsearch cluster and index privileges.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kibanas
List<Get
Kibana Security Role Kibana> - The list of objects that specify the Kibana privileges for the role.
- Metadata string
- Optional meta-data.
- Name string
- The name for the role.
- Kibana
Connections List<GetKibana Security Role Kibana Connection> - Kibana connection configuration block.
- Description string
- Description for the role
- Elasticsearch
Get
Kibana Security Role Elasticsearch - Elasticsearch cluster and index privileges.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kibanas
[]Get
Kibana Security Role Kibana - The list of objects that specify the Kibana privileges for the role.
- Metadata string
- Optional meta-data.
- Name string
- The name for the role.
- Kibana
Connections []GetKibana Security Role Kibana Connection - Kibana connection configuration block.
- description string
- Description for the role
- elasticsearch object
- Elasticsearch cluster and index privileges.
- id string
- The provider-assigned unique ID for this managed resource.
- kibanas list(object)
- The list of objects that specify the Kibana privileges for the role.
- metadata string
- Optional meta-data.
- name string
- The name for the role.
- kibana_
connections list(object) - Kibana connection configuration block.
- description String
- Description for the role
- elasticsearch
Get
Kibana Security Role Elasticsearch - Elasticsearch cluster and index privileges.
- id String
- The provider-assigned unique ID for this managed resource.
- kibanas
List<Get
Kibana Security Role Kibana> - The list of objects that specify the Kibana privileges for the role.
- metadata String
- Optional meta-data.
- name String
- The name for the role.
- kibana
Connections List<GetKibana Security Role Kibana Connection> - Kibana connection configuration block.
- description string
- Description for the role
- elasticsearch
Get
Kibana Security Role Elasticsearch - Elasticsearch cluster and index privileges.
- id string
- The provider-assigned unique ID for this managed resource.
- kibanas
Get
Kibana Security Role Kibana[] - The list of objects that specify the Kibana privileges for the role.
- metadata string
- Optional meta-data.
- name string
- The name for the role.
- kibana
Connections GetKibana Security Role Kibana Connection[] - Kibana connection configuration block.
- description str
- Description for the role
- elasticsearch
Get
Kibana Security Role Elasticsearch - Elasticsearch cluster and index privileges.
- id str
- The provider-assigned unique ID for this managed resource.
- kibanas
Sequence[Get
Kibana Security Role Kibana] - The list of objects that specify the Kibana privileges for the role.
- metadata str
- Optional meta-data.
- name str
- The name for the role.
- kibana_
connections Sequence[GetKibana Security Role Kibana Connection] - Kibana connection configuration block.
- description String
- Description for the role
- elasticsearch Property Map
- Elasticsearch cluster and index privileges.
- id String
- The provider-assigned unique ID for this managed 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.
- kibana
Connections List<Property Map> - Kibana connection configuration block.
Supporting Types
GetKibanaSecurityRoleElasticsearch
- Clusters List<string>
- List of the cluster privileges.
- Indices
List<Get
Kibana Security Role Elasticsearch Index> - A list of indices permissions entries.
- Remote
Indices List<GetKibana Security Role Elasticsearch Remote Index> - 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 List<string> - A list of usernames the owners of this role can impersonate.
- Clusters []string
- List of the cluster privileges.
- Indices
[]Get
Kibana Security Role Elasticsearch Index - A list of indices permissions entries.
- Remote
Indices []GetKibana Security Role Elasticsearch Remote Index - 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 []string - A list of usernames the owners of this role can impersonate.
- clusters list(string)
- List of the cluster privileges.
- indices list(object)
- A list of indices permissions entries.
- remote_
indices list(object) - 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 list(string) - A list of usernames the owners of this role can impersonate.
- clusters List<String>
- List of the cluster privileges.
- indices
List<Get
Kibana Security Role Elasticsearch Index> - A list of indices permissions entries.
- remote
Indices List<GetKibana Security Role Elasticsearch Remote Index> - 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 List<String> - A list of usernames the owners of this role can impersonate.
- clusters string[]
- List of the cluster privileges.
- indices
Get
Kibana Security Role Elasticsearch Index[] - A list of indices permissions entries.
- remote
Indices GetKibana Security Role Elasticsearch Remote Index[] - 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 string[] - A list of usernames the owners of this role can impersonate.
- clusters Sequence[str]
- List of the cluster privileges.
- indices
Sequence[Get
Kibana Security Role Elasticsearch Index] - A list of indices permissions entries.
- remote_
indices Sequence[GetKibana Security Role Elasticsearch Remote Index] - 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.
- remote
Indices 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.
- run
As List<String> - A list of usernames the owners of this role can impersonate.
GetKibanaSecurityRoleElasticsearchIndex
- Field
Security GetKibana Security Role Elasticsearch Index Field Security - The document fields that 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.
- Query string
- A search query that defines the documents the owners of the role have read access to.
- Field
Security GetKibana Security Role Elasticsearch Index Field Security - The document fields that 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.
- Query string
- A search query that defines the documents the owners of the role have read access to.
- field_
security object - The document fields that 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.
- query string
- A search query that defines the documents the owners of the role have read access to.
- field
Security GetKibana Security Role Elasticsearch Index Field Security - The document fields that 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.
- query String
- A search query that defines the documents the owners of the role have read access to.
- field
Security GetKibana Security Role Elasticsearch Index Field Security - The document fields that 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.
- query string
- A search query that defines the documents the owners of the role have read access to.
- field_
security GetKibana Security Role Elasticsearch Index Field Security - The document fields that 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.
- query str
- A search query that defines the documents the owners of the role have read access to.
- field
Security Property Map - The document fields that 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.
- query String
- A search query that defines the documents the owners of the role have read access to.
GetKibanaSecurityRoleElasticsearchIndexFieldSecurity
GetKibanaSecurityRoleElasticsearchRemoteIndex
- Clusters List<string>
- A list of cluster aliases to which the permissions in this entry apply.
- Field
Security GetKibana Security Role Elasticsearch Remote Index Field Security - The document fields that 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.
- 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.
- Field
Security GetKibana Security Role Elasticsearch Remote Index Field Security - The document fields that 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.
- 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.
- field_
security object - The document fields that 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.
- 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.
- field
Security GetKibana Security Role Elasticsearch Remote Index Field Security - The document fields that 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.
- 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.
- field
Security GetKibana Security Role Elasticsearch Remote Index Field Security - The document fields that 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.
- 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.
- field_
security GetKibana Security Role Elasticsearch Remote Index Field Security - The document fields that 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.
- 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.
- field
Security Property Map - The document fields that 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.
- query String
- A search query that defines the documents the owners of the role have read access to.
GetKibanaSecurityRoleElasticsearchRemoteIndexFieldSecurity
GetKibanaSecurityRoleKibana
- Bases List<string>
- A base privilege. When specified, the base must be ["all"] or ["read"].
- Features
List<Get
Kibana Security Role Kibana Feature> - List of privileges for specific features.
- Spaces List<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"].
- Features
[]Get
Kibana Security Role Kibana Feature - List of privileges for specific features.
- Spaces []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"].
- features list(object)
- List of privileges for specific features.
- 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"].
- features
List<Get
Kibana Security Role Kibana Feature> - List of privileges for specific features.
- spaces List<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"].
- features
Get
Kibana Security Role Kibana Feature[] - List of privileges for specific features.
- spaces string[]
- 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"].
- features
Sequence[Get
Kibana Security Role Kibana Feature] - List of privileges for specific features.
- spaces Sequence[str]
- 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"].
- features List<Property Map>
- List of privileges for specific features.
- spaces List<String>
- The spaces to apply the privileges to. To grant access to all spaces, set to ["*"], or omit the value.
GetKibanaSecurityRoleKibanaConnection
- Api
Key string - API Key to use for authentication to Kibana
- Bearer
Token string - Bearer Token to use for authentication to Kibana
- Ca
Certs List<string> - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- Endpoints List<string>
- Insecure bool
- Disable TLS certificate validation
- Password string
- Password to use for API authentication to Kibana.
- Username string
- Username to use for API authentication to Kibana.
- Api
Key string - API Key to use for authentication to Kibana
- Bearer
Token string - Bearer Token to use for authentication to Kibana
- Ca
Certs []string - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- Endpoints []string
- Insecure bool
- Disable TLS certificate validation
- Password string
- Password to use for API authentication to Kibana.
- Username string
- Username to use for API authentication to Kibana.
- api_
key string - API Key to use for authentication to Kibana
- bearer_
token string - Bearer Token to use for authentication to Kibana
- ca_
certs list(string) - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- endpoints list(string)
- insecure bool
- Disable TLS certificate validation
- password string
- Password to use for API authentication to Kibana.
- username string
- Username to use for API authentication to Kibana.
- api
Key String - API Key to use for authentication to Kibana
- bearer
Token String - Bearer Token to use for authentication to Kibana
- ca
Certs List<String> - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- endpoints List<String>
- insecure Boolean
- Disable TLS certificate validation
- password String
- Password to use for API authentication to Kibana.
- username String
- Username to use for API authentication to Kibana.
- api
Key string - API Key to use for authentication to Kibana
- bearer
Token string - Bearer Token to use for authentication to Kibana
- ca
Certs string[] - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- endpoints string[]
- insecure boolean
- Disable TLS certificate validation
- password string
- Password to use for API authentication to Kibana.
- username string
- Username to use for API authentication to Kibana.
- api_
key str - API Key to use for authentication to Kibana
- bearer_
token str - Bearer Token to use for authentication to Kibana
- ca_
certs Sequence[str] - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- endpoints Sequence[str]
- insecure bool
- Disable TLS certificate validation
- password str
- Password to use for API authentication to Kibana.
- username str
- Username to use for API authentication to Kibana.
- api
Key String - API Key to use for authentication to Kibana
- bearer
Token String - Bearer Token to use for authentication to Kibana
- ca
Certs List<String> - A list of paths to CA certificates to validate the certificate presented by the Kibana server.
- endpoints List<String>
- insecure Boolean
- Disable TLS certificate validation
- password String
- Password to use for API authentication to Kibana.
- username String
- Username to use for API authentication to Kibana.
GetKibanaSecurityRoleKibanaFeature
- 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 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.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
Viewing docs for elasticstack 0.15.2
published on Tuesday, May 19, 2026 by elastic
published on Tuesday, May 19, 2026 by elastic
