1. Packages
  2. Splunk
  3. API Docs
  4. ShIndexesManager
Splunk v1.2.6 published on Thursday, Mar 21, 2024 by Pulumi

splunk.ShIndexesManager

Explore with Pulumi AI

splunk logo
Splunk v1.2.6 published on Thursday, Mar 21, 2024 by Pulumi

    # 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", {
        datatype: "event",
        frozenTimePeriodInSecs: "94608000",
        maxGlobalRawDataSizeMb: "100",
    });
    
    import pulumi
    import pulumi_splunk as splunk
    
    tf_index = splunk.ShIndexesManager("tf-index",
        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{
    			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()
        {
            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()        
                .datatype("event")
                .frozenTimePeriodInSecs("94608000")
                .maxGlobalRawDataSizeMb("100")
                .build());
    
        }
    }
    
    resources:
      tf-index:
        type: splunk:ShIndexesManager
        properties:
          datatype: event
          frozenTimePeriodInSecs: '94608000'
          maxGlobalRawDataSizeMb: '100'
    

    Create ShIndexesManager Resource

    new ShIndexesManager(name: string, args?: ShIndexesManagerArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def ShIndexesManager(resource_name: str,
                         args: Optional[ShIndexesManagerArgs] = None,
                         opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The ShIndexesManager resource accepts the following input properties:

    Acl ShIndexesManagerAcl
    Datatype string
    Valid values: (event | metric). Specifies the type of index.
    FrozenTimePeriodInSecs string
    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.
    MaxGlobalRawDataSizeMb string
    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 ShIndexesManagerAclArgs
    Datatype string
    Valid values: (event | metric). Specifies the type of index.
    FrozenTimePeriodInSecs string
    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.
    MaxGlobalRawDataSizeMb string
    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 ShIndexesManagerAcl
    datatype String
    Valid values: (event | metric). Specifies the type of index.
    frozenTimePeriodInSecs String
    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.
    maxGlobalRawDataSizeMb String
    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 ShIndexesManagerAcl
    datatype string
    Valid values: (event | metric). Specifies the type of index.
    frozenTimePeriodInSecs string
    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.
    maxGlobalRawDataSizeMb string
    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 ShIndexesManagerAclArgs
    datatype str
    Valid values: (event | metric). Specifies the type of index.
    frozen_time_period_in_secs str
    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_raw_data_size_mb str
    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.
    frozenTimePeriodInSecs String
    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.
    maxGlobalRawDataSizeMb String
    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.
    The following state arguments are supported:
    Acl ShIndexesManagerAcl
    Datatype string
    Valid values: (event | metric). Specifies the type of index.
    FrozenTimePeriodInSecs string
    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.
    MaxGlobalRawDataSizeMb string
    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 ShIndexesManagerAclArgs
    Datatype string
    Valid values: (event | metric). Specifies the type of index.
    FrozenTimePeriodInSecs string
    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.
    MaxGlobalRawDataSizeMb string
    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 ShIndexesManagerAcl
    datatype String
    Valid values: (event | metric). Specifies the type of index.
    frozenTimePeriodInSecs String
    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.
    maxGlobalRawDataSizeMb String
    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 ShIndexesManagerAcl
    datatype string
    Valid values: (event | metric). Specifies the type of index.
    frozenTimePeriodInSecs string
    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.
    maxGlobalRawDataSizeMb string
    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 ShIndexesManagerAclArgs
    datatype str
    Valid values: (event | metric). Specifies the type of index.
    frozen_time_period_in_secs str
    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_raw_data_size_mb str
    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.
    frozenTimePeriodInSecs String
    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.
    maxGlobalRawDataSizeMb String
    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
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite 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.
    Sharing 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 write permissions of the resource.
    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
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite 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.
    Sharing 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 write permissions of the resource.
    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
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite 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.
    sharing 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 write permissions of the resource.
    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
    canChangePerms boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite 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.
    sharing 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 write permissions of the resource.
    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_perms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    can_share_app bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    can_share_global bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    can_share_user 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.
    sharing 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 write permissions of the resource.
    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
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite 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.
    sharing 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 write permissions of the resource.

    Package Details

    Repository
    Splunk pulumi/pulumi-splunk
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splunk Terraform Provider.
    splunk logo
    Splunk v1.2.6 published on Thursday, Mar 21, 2024 by Pulumi