Docs Packages
  1. Packages
  2. Splunk
  3. API Docs
  4. ShIndexesManager
Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi
pulumi/pulumi-splunk

splunk.ShIndexesManager

Explore with Pulumi AI

splunk logo
Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi
pulumi/pulumi-splunk

    # 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

    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 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
	})
}

    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());

    }
}

    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")

    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",
});

    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
    CanChangePerms bool
    CanShareApp bool
    CanShareGlobal bool
    CanShareUser bool
    CanWrite bool
    Owner string
    Reads List<string>
    Removable bool
    Sharing string
    Writes List<string>
    App string
    CanChangePerms bool
    CanShareApp bool
    CanShareGlobal bool
    CanShareUser bool
    CanWrite bool
    Owner string
    Reads []string
    Removable bool
    Sharing string
    Writes []string
    app String
    canChangePerms Boolean
    canShareApp Boolean
    canShareGlobal Boolean
    canShareUser Boolean
    canWrite Boolean
    owner String
    reads List<String>
    removable Boolean
    sharing String
    writes List<String>
    app string
    canChangePerms boolean
    canShareApp boolean
    canShareGlobal boolean
    canShareUser boolean
    canWrite boolean
    owner string
    reads string[]
    removable boolean
    sharing string
    writes string[]
    app str
    can_change_perms bool
    can_share_app bool
    can_share_global bool
    can_share_user bool
    can_write bool
    owner str
    reads Sequence[str]
    removable bool
    sharing str
    writes Sequence[str]
    app String
    canChangePerms Boolean
    canShareApp Boolean
    canShareGlobal Boolean
    canShareUser Boolean
    canWrite Boolean
    owner String
    reads List<String>
    removable Boolean
    sharing String
    writes List<String>

    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.4 published on Thursday, Aug 24, 2023 by Pulumi
    pulumi/pulumi-splunk