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

InputsMonitor

# Resource: splunk.InputsMonitor

Create or update a new file or directory monitor input.

Example Usage

using Pulumi;
using Splunk = Pulumi.Splunk;

class MyStack : Stack
{
    public MyStack()
    {
        var monitor = new Splunk.InputsMonitor("monitor", new Splunk.InputsMonitorArgs
        {
            Recursive = true,
            Sourcetype = "text",
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := splunk.NewInputsMonitor(ctx, "monitor", &splunk.InputsMonitorArgs{
            Recursive:  pulumi.Bool(true),
            Sourcetype: pulumi.String("text"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_splunk as splunk

monitor = splunk.InputsMonitor("monitor",
    recursive=True,
    sourcetype="text")
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const monitor = new splunk.InputsMonitor("monitor", {
    recursive: true,
    sourcetype: "text",
});

Create a InputsMonitor Resource

new InputsMonitor(name: string, args?: InputsMonitorArgs, opts?: CustomResourceOptions);
def InputsMonitor(resource_name: str, opts: Optional[ResourceOptions] = None, acl: Optional[InputsMonitorAclArgs] = None, blacklist: Optional[str] = None, crc_salt: Optional[str] = None, disabled: Optional[bool] = None, follow_tail: Optional[bool] = None, host: Optional[str] = None, host_regex: Optional[str] = None, host_segment: Optional[int] = None, ignore_older_than: Optional[str] = None, index: Optional[str] = None, name: Optional[str] = None, recursive: Optional[bool] = None, rename_source: Optional[str] = None, sourcetype: Optional[str] = None, time_before_close: Optional[int] = None, whitelist: Optional[str] = None)
func NewInputsMonitor(ctx *Context, name string, args *InputsMonitorArgs, opts ...ResourceOption) (*InputsMonitor, error)
public InputsMonitor(string name, InputsMonitorArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args InputsMonitorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InputsMonitorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InputsMonitorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

InputsMonitor Resource Properties

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

Inputs

The InputsMonitor resource accepts the following input properties:

Acl InputsMonitorAclArgs

The app/user context that is the namespace for the resource

Blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

CrcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

Disabled bool

Indicates if input monitoring is disabled.

FollowTail bool

If set to true, files that are seen for the first time is read from the end.

Host string

The value to populate in the host field for events from this data input.

HostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

HostSegment int

Use the specified slash-separate segment of the filepath as the host field value.

IgnoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

Index string

Which index events from this input should be stored in. Defaults to default.

Name string

The file or directory path to monitor on the system.

Recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

RenameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

Sourcetype string

The value to populate in the sourcetype field for incoming events.

TimeBeforeClose int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

Whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

Acl InputsMonitorAcl

The app/user context that is the namespace for the resource

Blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

CrcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

Disabled bool

Indicates if input monitoring is disabled.

FollowTail bool

If set to true, files that are seen for the first time is read from the end.

Host string

The value to populate in the host field for events from this data input.

HostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

HostSegment int

Use the specified slash-separate segment of the filepath as the host field value.

IgnoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

Index string

Which index events from this input should be stored in. Defaults to default.

Name string

The file or directory path to monitor on the system.

Recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

RenameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

Sourcetype string

The value to populate in the sourcetype field for incoming events.

TimeBeforeClose int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

Whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

acl InputsMonitorAcl

The app/user context that is the namespace for the resource

blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

crcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

disabled boolean

Indicates if input monitoring is disabled.

followTail boolean

If set to true, files that are seen for the first time is read from the end.

host string

The value to populate in the host field for events from this data input.

hostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

hostSegment number

Use the specified slash-separate segment of the filepath as the host field value.

ignoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

index string

Which index events from this input should be stored in. Defaults to default.

name string

The file or directory path to monitor on the system.

recursive boolean

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

renameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

sourcetype string

The value to populate in the sourcetype field for incoming events.

timeBeforeClose number

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

acl InputsMonitorAclArgs

The app/user context that is the namespace for the resource

blacklist str

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

crc_salt str

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

disabled bool

Indicates if input monitoring is disabled.

follow_tail bool

If set to true, files that are seen for the first time is read from the end.

host str

The value to populate in the host field for events from this data input.

host_regex str

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

host_segment int

Use the specified slash-separate segment of the filepath as the host field value.

ignore_older_than str

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

index str

Which index events from this input should be stored in. Defaults to default.

name str

The file or directory path to monitor on the system.

recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

rename_source str

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

sourcetype str

The value to populate in the sourcetype field for incoming events.

time_before_close int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

whitelist str

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

Outputs

All input properties are implicitly available as output properties. Additionally, the InputsMonitor resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing InputsMonitor Resource

Get an existing InputsMonitor 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?: InputsMonitorState, opts?: CustomResourceOptions): InputsMonitor
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, acl: Optional[InputsMonitorAclArgs] = None, blacklist: Optional[str] = None, crc_salt: Optional[str] = None, disabled: Optional[bool] = None, follow_tail: Optional[bool] = None, host: Optional[str] = None, host_regex: Optional[str] = None, host_segment: Optional[int] = None, ignore_older_than: Optional[str] = None, index: Optional[str] = None, name: Optional[str] = None, recursive: Optional[bool] = None, rename_source: Optional[str] = None, sourcetype: Optional[str] = None, time_before_close: Optional[int] = None, whitelist: Optional[str] = None) -> InputsMonitor
func GetInputsMonitor(ctx *Context, name string, id IDInput, state *InputsMonitorState, opts ...ResourceOption) (*InputsMonitor, error)
public static InputsMonitor Get(string name, Input<string> id, InputsMonitorState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Acl InputsMonitorAclArgs

The app/user context that is the namespace for the resource

Blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

CrcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

Disabled bool

Indicates if input monitoring is disabled.

FollowTail bool

If set to true, files that are seen for the first time is read from the end.

Host string

The value to populate in the host field for events from this data input.

HostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

HostSegment int

Use the specified slash-separate segment of the filepath as the host field value.

IgnoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

Index string

Which index events from this input should be stored in. Defaults to default.

Name string

The file or directory path to monitor on the system.

Recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

RenameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

Sourcetype string

The value to populate in the sourcetype field for incoming events.

TimeBeforeClose int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

Whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

Acl InputsMonitorAcl

The app/user context that is the namespace for the resource

Blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

CrcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

Disabled bool

Indicates if input monitoring is disabled.

FollowTail bool

If set to true, files that are seen for the first time is read from the end.

Host string

The value to populate in the host field for events from this data input.

HostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

HostSegment int

Use the specified slash-separate segment of the filepath as the host field value.

IgnoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

Index string

Which index events from this input should be stored in. Defaults to default.

Name string

The file or directory path to monitor on the system.

Recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

RenameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

Sourcetype string

The value to populate in the sourcetype field for incoming events.

TimeBeforeClose int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

Whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

acl InputsMonitorAcl

The app/user context that is the namespace for the resource

blacklist string

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

crcSalt string

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

disabled boolean

Indicates if input monitoring is disabled.

followTail boolean

If set to true, files that are seen for the first time is read from the end.

host string

The value to populate in the host field for events from this data input.

hostRegex string

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

hostSegment number

Use the specified slash-separate segment of the filepath as the host field value.

ignoreOlderThan string

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

index string

Which index events from this input should be stored in. Defaults to default.

name string

The file or directory path to monitor on the system.

recursive boolean

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

renameSource string

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

sourcetype string

The value to populate in the sourcetype field for incoming events.

timeBeforeClose number

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

whitelist string

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

acl InputsMonitorAclArgs

The app/user context that is the namespace for the resource

blacklist str

Specify a regular expression for a file path. The file path that matches this regular expression is not indexed.

crc_salt str

A string that modifies the file tracking identity for files in this input. The magic value invokes special behavior.

disabled bool

Indicates if input monitoring is disabled.

follow_tail bool

If set to true, files that are seen for the first time is read from the end.

host str

The value to populate in the host field for events from this data input.

host_regex str

Specify a regular expression for a file path. If the path for a file matches this regular expression, the captured value is used to populate the host field for events from this data input. The regular expression must have one capture group.

host_segment int

Use the specified slash-separate segment of the filepath as the host field value.

ignore_older_than str

Specify a time value. If the modification time of a file being monitored falls outside of this rolling time window, the file is no longer being monitored.

index str

Which index events from this input should be stored in. Defaults to default.

name str

The file or directory path to monitor on the system.

recursive bool

Setting this to false prevents monitoring of any subdirectories encountered within this data input.

rename_source str

The value to populate in the source field for events from this data input. The same source should not be used for multiple data inputs.

sourcetype str

The value to populate in the sourcetype field for incoming events.

time_before_close int

When Splunk software reaches the end of a file that is being read, the file is kept open for a minimum of the number of seconds specified in this value. After this period has elapsed, the file is checked again for more data.

whitelist str

Specify a regular expression for a file path. Only file paths that match this regular expression are indexed.

Supporting Types

InputsMonitorAcl

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 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]

Package Details

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