splunk.ShIndexesManager
Explore with Pulumi AI
# Resource: splunk.ShIndexesManager
Create indexes on Splunk Cloud instances. [BETA]
Authorization and authentication
As of now there is no support to create indexes in user-specified workspaces on Splunk Cloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";
const tf_index = new splunk.ShIndexesManager("tf-index", {
name: "tf-test-index-0",
datatype: "event",
frozenTimePeriodInSecs: "94608000",
maxGlobalRawDataSizeMb: "100",
});
import pulumi
import pulumi_splunk as splunk
tf_index = splunk.ShIndexesManager("tf-index",
name="tf-test-index-0",
datatype="event",
frozen_time_period_in_secs="94608000",
max_global_raw_data_size_mb="100")
package main
import (
"github.com/pulumi/pulumi-splunk/sdk/go/splunk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := splunk.NewShIndexesManager(ctx, "tf-index", &splunk.ShIndexesManagerArgs{
Name: pulumi.String("tf-test-index-0"),
Datatype: pulumi.String("event"),
FrozenTimePeriodInSecs: pulumi.String("94608000"),
MaxGlobalRawDataSizeMb: pulumi.String("100"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;
return await Deployment.RunAsync(() =>
{
var tf_index = new Splunk.ShIndexesManager("tf-index", new()
{
Name = "tf-test-index-0",
Datatype = "event",
FrozenTimePeriodInSecs = "94608000",
MaxGlobalRawDataSizeMb = "100",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.ShIndexesManager;
import com.pulumi.splunk.ShIndexesManagerArgs;
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 tf_index = new ShIndexesManager("tf-index", ShIndexesManagerArgs.builder()
.name("tf-test-index-0")
.datatype("event")
.frozenTimePeriodInSecs("94608000")
.maxGlobalRawDataSizeMb("100")
.build());
}
}
resources:
tf-index:
type: splunk:ShIndexesManager
properties:
name: tf-test-index-0
datatype: event
frozenTimePeriodInSecs: '94608000'
maxGlobalRawDataSizeMb: '100'
Create ShIndexesManager Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ShIndexesManager(name: string, args?: ShIndexesManagerArgs, opts?: CustomResourceOptions);
@overload
def ShIndexesManager(resource_name: str,
args: Optional[ShIndexesManagerArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ShIndexesManager(resource_name: str,
opts: Optional[ResourceOptions] = None,
acl: Optional[ShIndexesManagerAclArgs] = None,
datatype: Optional[str] = None,
frozen_time_period_in_secs: Optional[str] = None,
max_global_raw_data_size_mb: Optional[str] = None,
name: Optional[str] = None)
func NewShIndexesManager(ctx *Context, name string, args *ShIndexesManagerArgs, opts ...ResourceOption) (*ShIndexesManager, error)
public ShIndexesManager(string name, ShIndexesManagerArgs? args = null, CustomResourceOptions? opts = null)
public ShIndexesManager(String name, ShIndexesManagerArgs args)
public ShIndexesManager(String name, ShIndexesManagerArgs args, CustomResourceOptions options)
type: splunk:ShIndexesManager
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 ShIndexesManagerArgs
- 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 ShIndexesManagerArgs
- 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 ShIndexesManagerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ShIndexesManagerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ShIndexesManagerArgs
- 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 shIndexesManagerResource = new Splunk.ShIndexesManager("shIndexesManagerResource", new()
{
Acl = new Splunk.Inputs.ShIndexesManagerAclArgs
{
App = "string",
CanChangePerms = false,
CanShareApp = false,
CanShareGlobal = false,
CanShareUser = false,
CanWrite = false,
Owner = "string",
Reads = new[]
{
"string",
},
Removable = false,
Sharing = "string",
Writes = new[]
{
"string",
},
},
Datatype = "string",
FrozenTimePeriodInSecs = "string",
MaxGlobalRawDataSizeMb = "string",
Name = "string",
});
example, err := splunk.NewShIndexesManager(ctx, "shIndexesManagerResource", &splunk.ShIndexesManagerArgs{
Acl: &splunk.ShIndexesManagerAclArgs{
App: pulumi.String("string"),
CanChangePerms: pulumi.Bool(false),
CanShareApp: pulumi.Bool(false),
CanShareGlobal: pulumi.Bool(false),
CanShareUser: pulumi.Bool(false),
CanWrite: pulumi.Bool(false),
Owner: pulumi.String("string"),
Reads: pulumi.StringArray{
pulumi.String("string"),
},
Removable: pulumi.Bool(false),
Sharing: pulumi.String("string"),
Writes: pulumi.StringArray{
pulumi.String("string"),
},
},
Datatype: pulumi.String("string"),
FrozenTimePeriodInSecs: pulumi.String("string"),
MaxGlobalRawDataSizeMb: pulumi.String("string"),
Name: pulumi.String("string"),
})
var shIndexesManagerResource = new ShIndexesManager("shIndexesManagerResource", ShIndexesManagerArgs.builder()
.acl(ShIndexesManagerAclArgs.builder()
.app("string")
.canChangePerms(false)
.canShareApp(false)
.canShareGlobal(false)
.canShareUser(false)
.canWrite(false)
.owner("string")
.reads("string")
.removable(false)
.sharing("string")
.writes("string")
.build())
.datatype("string")
.frozenTimePeriodInSecs("string")
.maxGlobalRawDataSizeMb("string")
.name("string")
.build());
sh_indexes_manager_resource = splunk.ShIndexesManager("shIndexesManagerResource",
acl={
"app": "string",
"can_change_perms": False,
"can_share_app": False,
"can_share_global": False,
"can_share_user": False,
"can_write": False,
"owner": "string",
"reads": ["string"],
"removable": False,
"sharing": "string",
"writes": ["string"],
},
datatype="string",
frozen_time_period_in_secs="string",
max_global_raw_data_size_mb="string",
name="string")
const shIndexesManagerResource = new splunk.ShIndexesManager("shIndexesManagerResource", {
acl: {
app: "string",
canChangePerms: false,
canShareApp: false,
canShareGlobal: false,
canShareUser: false,
canWrite: false,
owner: "string",
reads: ["string"],
removable: false,
sharing: "string",
writes: ["string"],
},
datatype: "string",
frozenTimePeriodInSecs: "string",
maxGlobalRawDataSizeMb: "string",
name: "string",
});
type: splunk:ShIndexesManager
properties:
acl:
app: string
canChangePerms: false
canShareApp: false
canShareGlobal: false
canShareUser: false
canWrite: false
owner: string
reads:
- string
removable: false
sharing: string
writes:
- string
datatype: string
frozenTimePeriodInSecs: string
maxGlobalRawDataSizeMb: string
name: string
ShIndexesManager 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 ShIndexesManager resource accepts the following input properties:
- Acl
Sh
Indexes Manager Acl - Datatype string
- Valid values: (event | metric). Specifies the type of index.
- Frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- Max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- Name string
- The name of the index to create.
- Acl
Sh
Indexes Manager Acl Args - Datatype string
- Valid values: (event | metric). Specifies the type of index.
- Frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- Max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- Name string
- The name of the index to create.
- acl
Sh
Indexes Manager Acl - datatype String
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time StringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global StringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name String
- The name of the index to create.
- acl
Sh
Indexes Manager Acl - datatype string
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name string
- The name of the index to create.
- acl
Sh
Indexes Manager Acl Args - datatype str
- Valid values: (event | metric). Specifies the type of index.
- frozen_
time_ strperiod_ in_ secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max_
global_ strraw_ data_ size_ mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name str
- The name of the index to create.
- acl Property Map
- datatype String
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time StringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global StringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name String
- The name of the index to create.
Outputs
All input properties are implicitly available as output properties. Additionally, the ShIndexesManager 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 ShIndexesManager Resource
Get an existing ShIndexesManager 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?: ShIndexesManagerState, opts?: CustomResourceOptions): ShIndexesManager
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
acl: Optional[ShIndexesManagerAclArgs] = None,
datatype: Optional[str] = None,
frozen_time_period_in_secs: Optional[str] = None,
max_global_raw_data_size_mb: Optional[str] = None,
name: Optional[str] = None) -> ShIndexesManager
func GetShIndexesManager(ctx *Context, name string, id IDInput, state *ShIndexesManagerState, opts ...ResourceOption) (*ShIndexesManager, error)
public static ShIndexesManager Get(string name, Input<string> id, ShIndexesManagerState? state, CustomResourceOptions? opts = null)
public static ShIndexesManager get(String name, Output<String> id, ShIndexesManagerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Acl
Sh
Indexes Manager Acl - Datatype string
- Valid values: (event | metric). Specifies the type of index.
- Frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- Max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- Name string
- The name of the index to create.
- Acl
Sh
Indexes Manager Acl Args - Datatype string
- Valid values: (event | metric). Specifies the type of index.
- Frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- Max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- Name string
- The name of the index to create.
- acl
Sh
Indexes Manager Acl - datatype String
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time StringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global StringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name String
- The name of the index to create.
- acl
Sh
Indexes Manager Acl - datatype string
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time stringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global stringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name string
- The name of the index to create.
- acl
Sh
Indexes Manager Acl Args - datatype str
- Valid values: (event | metric). Specifies the type of index.
- frozen_
time_ strperiod_ in_ secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max_
global_ strraw_ data_ size_ mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name str
- The name of the index to create.
- acl Property Map
- datatype String
- Valid values: (event | metric). Specifies the type of index.
- frozen
Time StringPeriod In Secs - Number of seconds after which indexed data rolls to frozen. Defaults to 94608000 (3 years).Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation.
- max
Global StringRaw Data Size Mb - The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. Defaults to 100 MB.
- name String
- The name of the index to create.
Supporting Types
ShIndexesManagerAcl, ShIndexesManagerAclArgs
- App string
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- Can
Change boolPerms - Indicates if the active user can change permissions for this object. Defaults to true.
- bool
- Indicates if the active user can change sharing to app level. Defaults to true.
- bool
- Indicates if the active user can change sharing to system level. Defaults to true.
- bool
- Indicates if the active user can change sharing to user level. Defaults to true.
- Can
Write bool - Indicates if the active user can edit this object. Defaults to true.
- Owner string
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- Reads List<string>
- Properties that indicate resource read permissions.
- Removable bool
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- string
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- Writes List<string>
- Properties that indicate resource write permissions.
- App string
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- Can
Change boolPerms - Indicates if the active user can change permissions for this object. Defaults to true.
- bool
- Indicates if the active user can change sharing to app level. Defaults to true.
- bool
- Indicates if the active user can change sharing to system level. Defaults to true.
- bool
- Indicates if the active user can change sharing to user level. Defaults to true.
- Can
Write bool - Indicates if the active user can edit this object. Defaults to true.
- Owner string
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- Reads []string
- Properties that indicate resource read permissions.
- Removable bool
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- string
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- Writes []string
- Properties that indicate resource write permissions.
- app String
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- can
Change BooleanPerms - Indicates if the active user can change permissions for this object. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to app level. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to system level. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to user level. Defaults to true.
- can
Write Boolean - Indicates if the active user can edit this object. Defaults to true.
- owner String
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- reads List<String>
- Properties that indicate resource read permissions.
- removable Boolean
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- String
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- writes List<String>
- Properties that indicate resource write permissions.
- app string
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- can
Change booleanPerms - Indicates if the active user can change permissions for this object. Defaults to true.
- boolean
- Indicates if the active user can change sharing to app level. Defaults to true.
- boolean
- Indicates if the active user can change sharing to system level. Defaults to true.
- boolean
- Indicates if the active user can change sharing to user level. Defaults to true.
- can
Write boolean - Indicates if the active user can edit this object. Defaults to true.
- owner string
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- reads string[]
- Properties that indicate resource read permissions.
- removable boolean
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- string
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- writes string[]
- Properties that indicate resource write permissions.
- app str
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- can_
change_ boolperms - Indicates if the active user can change permissions for this object. Defaults to true.
- bool
- Indicates if the active user can change sharing to app level. Defaults to true.
- bool
- Indicates if the active user can change sharing to system level. Defaults to true.
- bool
- Indicates if the active user can change sharing to user level. Defaults to true.
- can_
write bool - Indicates if the active user can edit this object. Defaults to true.
- owner str
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- reads Sequence[str]
- Properties that indicate resource read permissions.
- removable bool
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- str
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- writes Sequence[str]
- Properties that indicate resource write permissions.
- app String
- The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
- can
Change BooleanPerms - Indicates if the active user can change permissions for this object. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to app level. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to system level. Defaults to true.
- Boolean
- Indicates if the active user can change sharing to user level. Defaults to true.
- can
Write Boolean - Indicates if the active user can edit this object. Defaults to true.
- owner String
- User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
- reads List<String>
- Properties that indicate resource read permissions.
- removable Boolean
- Indicates whether an admin or user with sufficient permissions can delete the entity.
- String
- Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
- writes List<String>
- Properties that indicate resource write permissions.
Package Details
- Repository
- Splunk pulumi/pulumi-splunk
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
splunk
Terraform Provider.