InputsScript
# Resource: splunk.InputsScript
Create or update scripted inputs.
Create a InputsScript Resource
new InputsScript(name: string, args: InputsScriptArgs, opts?: CustomResourceOptions);
def InputsScript(resource_name: 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)
func NewInputsScript(ctx *Context, name string, args InputsScriptArgs, opts ...ResourceOption) (*InputsScript, error)
public InputsScript(string name, InputsScriptArgs args, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args InputsScriptArgs
- 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 InputsScriptArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InputsScriptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
InputsScript Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The InputsScript resource accepts the following input properties:
- 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.
- Acl
Inputs
Script Acl Args 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 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.
- Rename
Source 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 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
Inputs
Script Acl 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 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.
- Rename
Source 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 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
Inputs
Script Acl 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 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.
- rename
Source 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 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
Inputs
Script Acl Args 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 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.
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 str
- The provider-assigned unique ID for this managed resource.
Look up an 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)
- 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
Inputs
Script Acl Args 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 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.
- Rename
Source 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
Inputs
Script Acl 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 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.
- Rename
Source 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
Inputs
Script Acl 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 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.
- rename
Source 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
Inputs
Script Acl Args 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 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.
Supporting Types
InputsScriptAcl
Package Details
- Repository
- https://github.com/pulumi/pulumi-splunk
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
splunk
Terraform Provider.