Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splunk Provider
  3. API Docs
  4. InputsScript
Splunk v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk

splunk.InputsScript

Explore with Pulumi AI

Splunk v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk

# Resource: splunk.InputsScript

Create or update scripted inputs.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const script = new splunk.InputsScript("script", {
    name: "opt/splunk/bin/scripts/readme.txt",
    interval: 360,
});
Copy
import pulumi
import pulumi_splunk as splunk

script = splunk.InputsScript("script",
    name="opt/splunk/bin/scripts/readme.txt",
    interval=360)
Copy
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.NewInputsScript(ctx, "script", &splunk.InputsScriptArgs{
			Name:     pulumi.String("opt/splunk/bin/scripts/readme.txt"),
			Interval: pulumi.Int(360),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var script = new Splunk.InputsScript("script", new()
    {
        Name = "opt/splunk/bin/scripts/readme.txt",
        Interval = 360,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.InputsScript;
import com.pulumi.splunk.InputsScriptArgs;
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 script = new InputsScript("script", InputsScriptArgs.builder()
            .name("opt/splunk/bin/scripts/readme.txt")
            .interval(360)
            .build());

    }
}
Copy
resources:
  script:
    type: splunk:InputsScript
    properties:
      name: opt/splunk/bin/scripts/readme.txt
      interval: 360
Copy
terraform import splunk_inputs_script.bar "\$SPLUNK_HOME/etc/apps/splunk_instrumentation/bin/instrumentation.py"

Create InputsScript Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new InputsScript(name: string, args: InputsScriptArgs, opts?: CustomResourceOptions);
@overload
def InputsScript(resource_name: str,
                 args: InputsScriptArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def InputsScript(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 interval: Optional[int] = None,
                 acl: Optional[InputsScriptAclArgs] = None,
                 disabled: Optional[bool] = None,
                 host: Optional[str] = None,
                 index: Optional[str] = None,
                 name: Optional[str] = None,
                 passauth: Optional[str] = None,
                 rename_source: Optional[str] = None,
                 source: Optional[str] = None,
                 sourcetype: Optional[str] = None)
func NewInputsScript(ctx *Context, name string, args InputsScriptArgs, opts ...ResourceOption) (*InputsScript, error)
public InputsScript(string name, InputsScriptArgs args, CustomResourceOptions? opts = null)
public InputsScript(String name, InputsScriptArgs args)
public InputsScript(String name, InputsScriptArgs args, CustomResourceOptions options)

type: splunk:InputsScript
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InputsScriptArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InputsScriptArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InputsScriptArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InputsScriptArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InputsScriptArgs
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 inputsScriptResource = new Splunk.InputsScript("inputsScriptResource", new()
{
    Interval = 0,
    Acl = new Splunk.Inputs.InputsScriptAclArgs
    {
        App = "string",
        CanChangePerms = false,
        CanShareApp = false,
        CanShareGlobal = false,
        CanShareUser = false,
        CanWrite = false,
        Owner = "string",
        Reads = new[]
        {
            "string",
        },
        Removable = false,
        Sharing = "string",
        Writes = new[]
        {
            "string",
        },
    },
    Disabled = false,
    Host = "string",
    Index = "string",
    Name = "string",
    Passauth = "string",
    RenameSource = "string",
    Source = "string",
    Sourcetype = "string",
});
Copy
example, err := splunk.NewInputsScript(ctx, "inputsScriptResource", &splunk.InputsScriptArgs{
	Interval: pulumi.Int(0),
	Acl: &splunk.InputsScriptAclArgs{
		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"),
		},
	},
	Disabled:     pulumi.Bool(false),
	Host:         pulumi.String("string"),
	Index:        pulumi.String("string"),
	Name:         pulumi.String("string"),
	Passauth:     pulumi.String("string"),
	RenameSource: pulumi.String("string"),
	Source:       pulumi.String("string"),
	Sourcetype:   pulumi.String("string"),
})
Copy
var inputsScriptResource = new InputsScript("inputsScriptResource", InputsScriptArgs.builder()
    .interval(0)
    .acl(InputsScriptAclArgs.builder()
        .app("string")
        .canChangePerms(false)
        .canShareApp(false)
        .canShareGlobal(false)
        .canShareUser(false)
        .canWrite(false)
        .owner("string")
        .reads("string")
        .removable(false)
        .sharing("string")
        .writes("string")
        .build())
    .disabled(false)
    .host("string")
    .index("string")
    .name("string")
    .passauth("string")
    .renameSource("string")
    .source("string")
    .sourcetype("string")
    .build());
Copy
inputs_script_resource = splunk.InputsScript("inputsScriptResource",
    interval=0,
    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"],
    },
    disabled=False,
    host="string",
    index="string",
    name="string",
    passauth="string",
    rename_source="string",
    source="string",
    sourcetype="string")
Copy
const inputsScriptResource = new splunk.InputsScript("inputsScriptResource", {
    interval: 0,
    acl: {
        app: "string",
        canChangePerms: false,
        canShareApp: false,
        canShareGlobal: false,
        canShareUser: false,
        canWrite: false,
        owner: "string",
        reads: ["string"],
        removable: false,
        sharing: "string",
        writes: ["string"],
    },
    disabled: false,
    host: "string",
    index: "string",
    name: "string",
    passauth: "string",
    renameSource: "string",
    source: "string",
    sourcetype: "string",
});
Copy
type: splunk:InputsScript
properties:
    acl:
        app: string
        canChangePerms: false
        canShareApp: false
        canShareGlobal: false
        canShareUser: false
        canWrite: false
        owner: string
        reads:
            - string
        removable: false
        sharing: string
        writes:
            - string
    disabled: false
    host: string
    index: string
    interval: 0
    name: string
    passauth: string
    renameSource: string
    source: string
    sourcetype: string
Copy

InputsScript 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 InputsScript resource accepts the following input properties:

Interval This property is required. int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
Acl InputsScriptAcl
The app/user context that is the namespace for the resource
Disabled bool
Specifies whether the input script is disabled.
Host string
Sets the host for events from this input. Defaults to whatever host sent the event.
Index string
Sets the index for events from this input. Defaults to the main index.
Name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
Passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
RenameSource string
Specify a new name for the source field for the script.
Source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
Sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
Interval This property is required. int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
Acl InputsScriptAclArgs
The app/user context that is the namespace for the resource
Disabled bool
Specifies whether the input script is disabled.
Host string
Sets the host for events from this input. Defaults to whatever host sent the event.
Index string
Sets the index for events from this input. Defaults to the main index.
Name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
Passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
RenameSource string
Specify a new name for the source field for the script.
Source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
Sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
interval This property is required. Integer
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
acl InputsScriptAcl
The app/user context that is the namespace for the resource
disabled Boolean
Specifies whether the input script is disabled.
host String
Sets the host for events from this input. Defaults to whatever host sent the event.
index String
Sets the index for events from this input. Defaults to the main index.
name Changes to this property will trigger replacement. String
Specify the name of the scripted input.
passauth String
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource String
Specify a new name for the source field for the script.
source String
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype String
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
interval This property is required. number
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
acl InputsScriptAcl
The app/user context that is the namespace for the resource
disabled boolean
Specifies whether the input script is disabled.
host string
Sets the host for events from this input. Defaults to whatever host sent the event.
index string
Sets the index for events from this input. Defaults to the main index.
name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource string
Specify a new name for the source field for the script.
source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
interval This property is required. int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
acl InputsScriptAclArgs
The app/user context that is the namespace for the resource
disabled bool
Specifies whether the input script is disabled.
host str
Sets the host for events from this input. Defaults to whatever host sent the event.
index str
Sets the index for events from this input. Defaults to the main index.
name Changes to this property will trigger replacement. str
Specify the name of the scripted input.
passauth str
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
rename_source str
Specify a new name for the source field for the script.
source str
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype str
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
interval This property is required. Number
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
acl Property Map
The app/user context that is the namespace for the resource
disabled Boolean
Specifies whether the input script is disabled.
host String
Sets the host for events from this input. Defaults to whatever host sent the event.
index String
Sets the index for events from this input. Defaults to the main index.
name Changes to this property will trigger replacement. String
Specify the name of the scripted input.
passauth String
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource String
Specify a new name for the source field for the script.
source String
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype String
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.

Outputs

All input properties are implicitly available as output properties. Additionally, the InputsScript 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 InputsScript Resource

Get an existing InputsScript 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?: InputsScriptState, opts?: CustomResourceOptions): InputsScript
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[InputsScriptAclArgs] = None,
        disabled: Optional[bool] = None,
        host: Optional[str] = None,
        index: Optional[str] = None,
        interval: Optional[int] = None,
        name: Optional[str] = None,
        passauth: Optional[str] = None,
        rename_source: Optional[str] = None,
        source: Optional[str] = None,
        sourcetype: Optional[str] = None) -> InputsScript
func GetInputsScript(ctx *Context, name string, id IDInput, state *InputsScriptState, opts ...ResourceOption) (*InputsScript, error)
public static InputsScript Get(string name, Input<string> id, InputsScriptState? state, CustomResourceOptions? opts = null)
public static InputsScript get(String name, Output<String> id, InputsScriptState state, CustomResourceOptions options)
resources:  _:    type: splunk:InputsScript    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 InputsScriptAcl
The app/user context that is the namespace for the resource
Disabled bool
Specifies whether the input script is disabled.
Host string
Sets the host for events from this input. Defaults to whatever host sent the event.
Index string
Sets the index for events from this input. Defaults to the main index.
Interval int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
Name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
Passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
RenameSource string
Specify a new name for the source field for the script.
Source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
Sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
Acl InputsScriptAclArgs
The app/user context that is the namespace for the resource
Disabled bool
Specifies whether the input script is disabled.
Host string
Sets the host for events from this input. Defaults to whatever host sent the event.
Index string
Sets the index for events from this input. Defaults to the main index.
Interval int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
Name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
Passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
RenameSource string
Specify a new name for the source field for the script.
Source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
Sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
acl InputsScriptAcl
The app/user context that is the namespace for the resource
disabled Boolean
Specifies whether the input script is disabled.
host String
Sets the host for events from this input. Defaults to whatever host sent the event.
index String
Sets the index for events from this input. Defaults to the main index.
interval Integer
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
name Changes to this property will trigger replacement. String
Specify the name of the scripted input.
passauth String
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource String
Specify a new name for the source field for the script.
source String
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype String
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
acl InputsScriptAcl
The app/user context that is the namespace for the resource
disabled boolean
Specifies whether the input script is disabled.
host string
Sets the host for events from this input. Defaults to whatever host sent the event.
index string
Sets the index for events from this input. Defaults to the main index.
interval number
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
name Changes to this property will trigger replacement. string
Specify the name of the scripted input.
passauth string
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource string
Specify a new name for the source field for the script.
source string
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype string
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
acl InputsScriptAclArgs
The app/user context that is the namespace for the resource
disabled bool
Specifies whether the input script is disabled.
host str
Sets the host for events from this input. Defaults to whatever host sent the event.
index str
Sets the index for events from this input. Defaults to the main index.
interval int
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
name Changes to this property will trigger replacement. str
Specify the name of the scripted input.
passauth str
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
rename_source str
Specify a new name for the source field for the script.
source str
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype str
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.
acl Property Map
The app/user context that is the namespace for the resource
disabled Boolean
Specifies whether the input script is disabled.
host String
Sets the host for events from this input. Defaults to whatever host sent the event.
index String
Sets the index for events from this input. Defaults to the main index.
interval Number
Specify an integer or cron schedule. This parameter specifies how often to execute the specified script, in seconds or a valid cron schedule. If you specify a cron schedule, the script is not executed on start-up.
name Changes to this property will trigger replacement. String
Specify the name of the scripted input.
passauth String
User to run the script as. If you provide a username, Splunk software generates an auth token for that user and passes it to the script.
renameSource String
Specify a new name for the source field for the script.
source String
Sets the source key/field for events from this input. Defaults to the input file path. Sets the source key initial value. The key is used during parsing/indexing, in particular to set the source field during indexing. It is also the source field used at search time. As a convenience, the chosen string is prepended with 'source::'.
sourcetype String
Sets the sourcetype key/field for events from this input. If unset, Splunk software picks a source type based on various aspects of the data. As a convenience, the chosen string is prepended with 'sourcetype::'. There is no hard-coded default. Sets the sourcetype key initial value. The key is used during parsing/indexing, in particular to set the source type field during indexing. It is also the source type field used at search time.

Supporting Types

InputsScriptAcl
, InputsScriptAclArgs

App Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
Splunk v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk