Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

AuthorizationRoles

# Resource: splunk.AuthorizationRoles

Create and update role information.

Example Usage

using Pulumi;
using Splunk = Pulumi.Splunk;

class MyStack : Stack
{
    public MyStack()
    {
        var role01 = new Splunk.AuthorizationRoles("role01", new Splunk.AuthorizationRolesArgs
        {
            Capabilities = 
            {
                "accelerate_datamodel",
                "change_authentication",
                "restart_splunkd",
            },
            DefaultApp = "search",
            ImportedRoles = 
            {
                "power",
                "user",
            },
            SearchIndexesAlloweds = 
            {
                "_audit",
                "_internal",
                "main",
            },
            SearchIndexesDefaults = 
            {
                "_audit",
                "_internal",
                "main",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-splunk/sdk/go/splunk"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := splunk.NewAuthorizationRoles(ctx, "role01", &splunk.AuthorizationRolesArgs{
            Capabilities: pulumi.StringArray{
                pulumi.String("accelerate_datamodel"),
                pulumi.String("change_authentication"),
                pulumi.String("restart_splunkd"),
            },
            DefaultApp: pulumi.String("search"),
            ImportedRoles: pulumi.StringArray{
                pulumi.String("power"),
                pulumi.String("user"),
            },
            SearchIndexesAlloweds: pulumi.StringArray{
                pulumi.String("_audit"),
                pulumi.String("_internal"),
                pulumi.String("main"),
            },
            SearchIndexesDefaults: pulumi.StringArray{
                pulumi.String("_audit"),
                pulumi.String("_internal"),
                pulumi.String("main"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_splunk as splunk

role01 = splunk.AuthorizationRoles("role01",
    capabilities=[
        "accelerate_datamodel",
        "change_authentication",
        "restart_splunkd",
    ],
    default_app="search",
    imported_roles=[
        "power",
        "user",
    ],
    search_indexes_alloweds=[
        "_audit",
        "_internal",
        "main",
    ],
    search_indexes_defaults=[
        "_audit",
        "_internal",
        "main",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const role01 = new splunk.AuthorizationRoles("role01", {
    capabilities: [
        "accelerate_datamodel",
        "change_authentication",
        "restart_splunkd",
    ],
    defaultApp: "search",
    importedRoles: [
        "power",
        "user",
    ],
    searchIndexesAlloweds: [
        "_audit",
        "_internal",
        "main",
    ],
    searchIndexesDefaults: [
        "_audit",
        "_internal",
        "main",
    ],
});

Create a AuthorizationRoles Resource

new AuthorizationRoles(name: string, args?: AuthorizationRolesArgs, opts?: CustomResourceOptions);
def AuthorizationRoles(resource_name: str, opts: Optional[ResourceOptions] = None, capabilities: Optional[Sequence[str]] = None, cumulative_realtime_search_jobs_quota: Optional[int] = None, cumulative_search_jobs_quota: Optional[int] = None, default_app: Optional[str] = None, imported_roles: Optional[Sequence[str]] = None, name: Optional[str] = None, realtime_search_jobs_quota: Optional[int] = None, search_disk_quota: Optional[int] = None, search_filter: Optional[str] = None, search_indexes_alloweds: Optional[Sequence[str]] = None, search_indexes_defaults: Optional[Sequence[str]] = None, search_jobs_quota: Optional[int] = None, search_time_win: Optional[int] = None)
func NewAuthorizationRoles(ctx *Context, name string, args *AuthorizationRolesArgs, opts ...ResourceOption) (*AuthorizationRoles, error)
public AuthorizationRoles(string name, AuthorizationRolesArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AuthorizationRolesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AuthorizationRolesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthorizationRolesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AuthorizationRoles Resource Properties

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

Inputs

The AuthorizationRoles resource accepts the following input properties:

Capabilities List<string>

List of capabilities assigned to role.

CumulativeRealtimeSearchJobsQuota int

Maximum number of concurrently running real-time searches that all members of this role can have.

CumulativeSearchJobsQuota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

DefaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

ImportedRoles List<string>

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

Name string

The name of the user role to create.

RealtimeSearchJobsQuota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

SearchDiskQuota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

SearchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

SearchIndexesAlloweds List<string>

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

SearchIndexesDefaults List<string>

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

SearchJobsQuota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

SearchTimeWin int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

Capabilities []string

List of capabilities assigned to role.

CumulativeRealtimeSearchJobsQuota int

Maximum number of concurrently running real-time searches that all members of this role can have.

CumulativeSearchJobsQuota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

DefaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

ImportedRoles []string

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

Name string

The name of the user role to create.

RealtimeSearchJobsQuota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

SearchDiskQuota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

SearchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

SearchIndexesAlloweds []string

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

SearchIndexesDefaults []string

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

SearchJobsQuota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

SearchTimeWin int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

capabilities string[]

List of capabilities assigned to role.

cumulativeRealtimeSearchJobsQuota number

Maximum number of concurrently running real-time searches that all members of this role can have.

cumulativeSearchJobsQuota number

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

defaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

importedRoles string[]

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

name string

The name of the user role to create.

realtimeSearchJobsQuota number

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

searchDiskQuota number

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

searchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

searchIndexesAlloweds string[]

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

searchIndexesDefaults string[]

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

searchJobsQuota number

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

searchTimeWin number

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

capabilities Sequence[str]

List of capabilities assigned to role.

cumulative_realtime_search_jobs_quota int

Maximum number of concurrently running real-time searches that all members of this role can have.

cumulative_search_jobs_quota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

default_app str

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

imported_roles Sequence[str]

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

name str

The name of the user role to create.

realtime_search_jobs_quota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

search_disk_quota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

search_filter str

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

search_indexes_alloweds Sequence[str]

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

search_indexes_defaults Sequence[str]

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

search_jobs_quota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

search_time_win int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

Outputs

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

Look up an Existing AuthorizationRoles Resource

Get an existing AuthorizationRoles 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?: AuthorizationRolesState, opts?: CustomResourceOptions): AuthorizationRoles
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, capabilities: Optional[Sequence[str]] = None, cumulative_realtime_search_jobs_quota: Optional[int] = None, cumulative_search_jobs_quota: Optional[int] = None, default_app: Optional[str] = None, imported_roles: Optional[Sequence[str]] = None, name: Optional[str] = None, realtime_search_jobs_quota: Optional[int] = None, search_disk_quota: Optional[int] = None, search_filter: Optional[str] = None, search_indexes_alloweds: Optional[Sequence[str]] = None, search_indexes_defaults: Optional[Sequence[str]] = None, search_jobs_quota: Optional[int] = None, search_time_win: Optional[int] = None) -> AuthorizationRoles
func GetAuthorizationRoles(ctx *Context, name string, id IDInput, state *AuthorizationRolesState, opts ...ResourceOption) (*AuthorizationRoles, error)
public static AuthorizationRoles Get(string name, Input<string> id, AuthorizationRolesState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Capabilities List<string>

List of capabilities assigned to role.

CumulativeRealtimeSearchJobsQuota int

Maximum number of concurrently running real-time searches that all members of this role can have.

CumulativeSearchJobsQuota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

DefaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

ImportedRoles List<string>

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

Name string

The name of the user role to create.

RealtimeSearchJobsQuota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

SearchDiskQuota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

SearchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

SearchIndexesAlloweds List<string>

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

SearchIndexesDefaults List<string>

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

SearchJobsQuota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

SearchTimeWin int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

Capabilities []string

List of capabilities assigned to role.

CumulativeRealtimeSearchJobsQuota int

Maximum number of concurrently running real-time searches that all members of this role can have.

CumulativeSearchJobsQuota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

DefaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

ImportedRoles []string

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

Name string

The name of the user role to create.

RealtimeSearchJobsQuota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

SearchDiskQuota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

SearchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

SearchIndexesAlloweds []string

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

SearchIndexesDefaults []string

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

SearchJobsQuota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

SearchTimeWin int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

capabilities string[]

List of capabilities assigned to role.

cumulativeRealtimeSearchJobsQuota number

Maximum number of concurrently running real-time searches that all members of this role can have.

cumulativeSearchJobsQuota number

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

defaultApp string

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

importedRoles string[]

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

name string

The name of the user role to create.

realtimeSearchJobsQuota number

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

searchDiskQuota number

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

searchFilter string

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

searchIndexesAlloweds string[]

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

searchIndexesDefaults string[]

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

searchJobsQuota number

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

searchTimeWin number

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

capabilities Sequence[str]

List of capabilities assigned to role.

cumulative_realtime_search_jobs_quota int

Maximum number of concurrently running real-time searches that all members of this role can have.

cumulative_search_jobs_quota int

Maximum number of concurrently running searches for all role members. Warning message logged when limit is reached.

default_app str

Specify the folder name of the default app to use for this role. A user-specific default app overrides this.

imported_roles Sequence[str]

List of imported roles for this role.
Importing other roles imports all aspects of that role, such as capabilities and allowed indexes to search. In combining multiple roles, the effective value for each attribute is value with the broadest permissions.

name str

The name of the user role to create.

realtime_search_jobs_quota int

Specify the maximum number of concurrent real-time search jobs for this role. This count is independent from the normal search jobs limit.

search_disk_quota int

Specifies the maximum disk space in MB that can be used by a user’s search jobs. For example, a value of 100 limits this role to 100 MB total.

search_filter str

Specify a search string that restricts the scope of searches run by this role. Search results for this role only show events that also match the search string you specify. In the case that a user has multiple roles with different search filters, they are combined with an OR.

search_indexes_alloweds Sequence[str]

List of indexes that this role has permissions to search. These may be wildcarded, but the index name must begin with an underscore to match internal indexes.

search_indexes_defaults Sequence[str]

List of indexes to search when no index is specified. These indexes can be wildcarded, with the exception that ‘’ does not match internal indexes. To match internal indexes, start with ‘’. All internal indexes are represented by ‘’. A user with this role can search other indexes using “index= “

search_jobs_quota int

The maximum number of concurrent searches a user with this role is allowed to run. For users with multiple roles, the maximum quota value among all of the roles applies.

search_time_win int

Maximum time span of a search, in seconds. By default, searches are not limited to any specific time window. To override any search time windows from imported roles, set srchTimeWin to ‘0’, as the ‘admin’ role does.

Package Details

Repository
https://github.com/pulumi/pulumi-splunk
License
Apache-2.0
Notes
This Pulumi package is based on the splunk Terraform Provider.