Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splunk Provider
  3. API Docs
  4. InputsTcpRaw
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-splunk

splunk.InputsTcpRaw

Explore with Pulumi AI

splunk logo
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-splunk

    # Resource: splunk.InputsTcpRaw

    Create or update raw TCP input information for managing raw tcp inputs from forwarders.

    Example Usage

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

const tcpRaw = new splunk.InputsTcpRaw("tcp_raw", {
    name: "41000",
    index: "main",
    queue: "indexQueue",
    source: "new",
    sourcetype: "new",
    disabled: false,
});

    import pulumi
import pulumi_splunk as splunk

tcp_raw = splunk.InputsTcpRaw("tcp_raw",
    name="41000",
    index="main",
    queue="indexQueue",
    source="new",
    sourcetype="new",
    disabled=False)

    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.NewInputsTcpRaw(ctx, "tcp_raw", &splunk.InputsTcpRawArgs{
			Name:       pulumi.String("41000"),
			Index:      pulumi.String("main"),
			Queue:      pulumi.String("indexQueue"),
			Source:     pulumi.String("new"),
			Sourcetype: pulumi.String("new"),
			Disabled:   pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var tcpRaw = new Splunk.InputsTcpRaw("tcp_raw", new()
    {
        Name = "41000",
        Index = "main",
        Queue = "indexQueue",
        Source = "new",
        Sourcetype = "new",
        Disabled = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.InputsTcpRaw;
import com.pulumi.splunk.InputsTcpRawArgs;
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 tcpRaw = new InputsTcpRaw("tcpRaw", InputsTcpRawArgs.builder()
            .name("41000")
            .index("main")
            .queue("indexQueue")
            .source("new")
            .sourcetype("new")
            .disabled(false)
            .build());

    }
}

    resources:
  tcpRaw:
    type: splunk:InputsTcpRaw
    name: tcp_raw
    properties:
      name: '41000'
      index: main
      queue: indexQueue
      source: new
      sourcetype: new
      disabled: false

    Create InputsTcpRaw Resource

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

    Constructor syntax

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

@overload
def InputsTcpRaw(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 acl: Optional[InputsTcpRawAclArgs] = None,
                 connection_host: Optional[str] = None,
                 disabled: Optional[bool] = None,
                 host: Optional[str] = None,
                 index: Optional[str] = None,
                 name: Optional[str] = None,
                 queue: Optional[str] = None,
                 raw_tcp_done_timeout: Optional[int] = None,
                 restrict_to_host: Optional[str] = None,
                 source: Optional[str] = None,
                 sourcetype: Optional[str] = None)
    func NewInputsTcpRaw(ctx *Context, name string, args *InputsTcpRawArgs, opts ...ResourceOption) (*InputsTcpRaw, error)
    public InputsTcpRaw(string name, InputsTcpRawArgs? args = null, CustomResourceOptions? opts = null)
    public InputsTcpRaw(String name, InputsTcpRawArgs args)
public InputsTcpRaw(String name, InputsTcpRawArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args InputsTcpRawArgs
    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 InputsTcpRawArgs
    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 InputsTcpRawArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InputsTcpRawArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InputsTcpRawArgs
    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 inputsTcpRawResource = new Splunk.InputsTcpRaw("inputsTcpRawResource", new()
{
    Acl = new Splunk.Inputs.InputsTcpRawAclArgs
    {
        App = "string",
        CanChangePerms = false,
        CanShareApp = false,
        CanShareGlobal = false,
        CanShareUser = false,
        CanWrite = false,
        Owner = "string",
        Reads = new[]
        {
            "string",
        },
        Removable = false,
        Sharing = "string",
        Writes = new[]
        {
            "string",
        },
    },
    ConnectionHost = "string",
    Disabled = false,
    Host = "string",
    Index = "string",
    Name = "string",
    Queue = "string",
    RawTcpDoneTimeout = 0,
    RestrictToHost = "string",
    Source = "string",
    Sourcetype = "string",
});

    example, err := splunk.NewInputsTcpRaw(ctx, "inputsTcpRawResource", &splunk.InputsTcpRawArgs{
	Acl: &splunk.InputsTcpRawAclArgs{
		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"),
		},
	},
	ConnectionHost:    pulumi.String("string"),
	Disabled:          pulumi.Bool(false),
	Host:              pulumi.String("string"),
	Index:             pulumi.String("string"),
	Name:              pulumi.String("string"),
	Queue:             pulumi.String("string"),
	RawTcpDoneTimeout: pulumi.Int(0),
	RestrictToHost:    pulumi.String("string"),
	Source:            pulumi.String("string"),
	Sourcetype:        pulumi.String("string"),
})

    var inputsTcpRawResource = new InputsTcpRaw("inputsTcpRawResource", InputsTcpRawArgs.builder()
    .acl(InputsTcpRawAclArgs.builder()
        .app("string")
        .canChangePerms(false)
        .canShareApp(false)
        .canShareGlobal(false)
        .canShareUser(false)
        .canWrite(false)
        .owner("string")
        .reads("string")
        .removable(false)
        .sharing("string")
        .writes("string")
        .build())
    .connectionHost("string")
    .disabled(false)
    .host("string")
    .index("string")
    .name("string")
    .queue("string")
    .rawTcpDoneTimeout(0)
    .restrictToHost("string")
    .source("string")
    .sourcetype("string")
    .build());

    inputs_tcp_raw_resource = splunk.InputsTcpRaw("inputsTcpRawResource",
    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"],
    },
    connection_host="string",
    disabled=False,
    host="string",
    index="string",
    name="string",
    queue="string",
    raw_tcp_done_timeout=0,
    restrict_to_host="string",
    source="string",
    sourcetype="string")

    const inputsTcpRawResource = new splunk.InputsTcpRaw("inputsTcpRawResource", {
    acl: {
        app: "string",
        canChangePerms: false,
        canShareApp: false,
        canShareGlobal: false,
        canShareUser: false,
        canWrite: false,
        owner: "string",
        reads: ["string"],
        removable: false,
        sharing: "string",
        writes: ["string"],
    },
    connectionHost: "string",
    disabled: false,
    host: "string",
    index: "string",
    name: "string",
    queue: "string",
    rawTcpDoneTimeout: 0,
    restrictToHost: "string",
    source: "string",
    sourcetype: "string",
});

    type: splunk:InputsTcpRaw
properties:
    acl:
        app: string
        canChangePerms: false
        canShareApp: false
        canShareGlobal: false
        canShareUser: false
        canWrite: false
        owner: string
        reads:
            - string
        removable: false
        sharing: string
        writes:
            - string
    connectionHost: string
    disabled: false
    host: string
    index: string
    name: string
    queue: string
    rawTcpDoneTimeout: 0
    restrictToHost: string
    source: string
    sourcetype: string

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

    Acl InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    ConnectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    Disabled bool
    Indicates if input is disabled.
    Host string
    Host from which the indexer gets data.
    Index string
    Index to store generated events. Defaults to default.
    Name string
    The input port which receives raw data.
    Queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    RawTcpDoneTimeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    RestrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    Acl InputsTcpRawAclArgs
    The app/user context that is the namespace for the resource
    ConnectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    Disabled bool
    Indicates if input is disabled.
    Host string
    Host from which the indexer gets data.
    Index string
    Index to store generated events. Defaults to default.
    Name string
    The input port which receives raw data.
    Queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    RawTcpDoneTimeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    RestrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    connectionHost String
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled Boolean
    Indicates if input is disabled.
    host String
    Host from which the indexer gets data.
    index String
    Index to store generated events. Defaults to default.
    name String
    The input port which receives raw data.
    queue String
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout Integer
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost String
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    connectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled boolean
    Indicates if input is disabled.
    host string
    Host from which the indexer gets data.
    index string
    Index to store generated events. Defaults to default.
    name string
    The input port which receives raw data.
    queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout number
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAclArgs
    The app/user context that is the namespace for the resource
    connection_host str
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled bool
    Indicates if input is disabled.
    host str
    Host from which the indexer gets data.
    index str
    Index to store generated events. Defaults to default.
    name str
    The input port which receives raw data.
    queue str
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    raw_tcp_done_timeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrict_to_host str
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl Property Map
    The app/user context that is the namespace for the resource
    connectionHost String
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled Boolean
    Indicates if input is disabled.
    host String
    Host from which the indexer gets data.
    index String
    Index to store generated events. Defaults to default.
    name String
    The input port which receives raw data.
    queue String
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout Number
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost String
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).

    Outputs

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

    Get an existing InputsTcpRaw 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?: InputsTcpRawState, opts?: CustomResourceOptions): InputsTcpRaw
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[InputsTcpRawAclArgs] = None,
        connection_host: Optional[str] = None,
        disabled: Optional[bool] = None,
        host: Optional[str] = None,
        index: Optional[str] = None,
        name: Optional[str] = None,
        queue: Optional[str] = None,
        raw_tcp_done_timeout: Optional[int] = None,
        restrict_to_host: Optional[str] = None,
        source: Optional[str] = None,
        sourcetype: Optional[str] = None) -> InputsTcpRaw
    func GetInputsTcpRaw(ctx *Context, name string, id IDInput, state *InputsTcpRawState, opts ...ResourceOption) (*InputsTcpRaw, error)
    public static InputsTcpRaw Get(string name, Input<string> id, InputsTcpRawState? state, CustomResourceOptions? opts = null)
    public static InputsTcpRaw get(String name, Output<String> id, InputsTcpRawState 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 InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    ConnectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    Disabled bool
    Indicates if input is disabled.
    Host string
    Host from which the indexer gets data.
    Index string
    Index to store generated events. Defaults to default.
    Name string
    The input port which receives raw data.
    Queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    RawTcpDoneTimeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    RestrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    Acl InputsTcpRawAclArgs
    The app/user context that is the namespace for the resource
    ConnectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    Disabled bool
    Indicates if input is disabled.
    Host string
    Host from which the indexer gets data.
    Index string
    Index to store generated events. Defaults to default.
    Name string
    The input port which receives raw data.
    Queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    RawTcpDoneTimeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    RestrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    connectionHost String
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled Boolean
    Indicates if input is disabled.
    host String
    Host from which the indexer gets data.
    index String
    Index to store generated events. Defaults to default.
    name String
    The input port which receives raw data.
    queue String
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout Integer
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost String
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAcl
    The app/user context that is the namespace for the resource
    connectionHost string
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled boolean
    Indicates if input is disabled.
    host string
    Host from which the indexer gets data.
    index string
    Index to store generated events. Defaults to default.
    name string
    The input port which receives raw data.
    queue string
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout number
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost string
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl InputsTcpRawAclArgs
    The app/user context that is the namespace for the resource
    connection_host str
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled bool
    Indicates if input is disabled.
    host str
    Host from which the indexer gets data.
    index str
    Index to store generated events. Defaults to default.
    name str
    The input port which receives raw data.
    queue str
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    raw_tcp_done_timeout int
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrict_to_host str
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).
    acl Property Map
    The app/user context that is the namespace for the resource
    connectionHost String
    Valid values: (ip | dns | none) Set the host for the remote server that is sending data. ip sets the host to the IP address of the remote server sending data. dns sets the host to the reverse DNS entry for the IP address of the remote server sending data. none leaves the host as specified in inputs.conf, which is typically the Splunk system hostname. Default value is dns.
    disabled Boolean
    Indicates if input is disabled.
    host String
    Host from which the indexer gets data.
    index String
    Index to store generated events. Defaults to default.
    name String
    The input port which receives raw data.
    queue String
    Valid values: (parsingQueue | indexQueue) Specifies where the input processor should deposit the events it reads. Defaults to parsingQueue. Set queue to parsingQueue to apply props.conf and other parsing rules to your data. For more information about props.conf and rules for timestamping and linebreaking, refer to props.conf and the online documentation at "Monitor files and directories with inputs.conf" Set queue to indexQueue to send your data directly into the index.
    rawTcpDoneTimeout Number
    Specifies in seconds the timeout value for adding a Done-key. Default value is 10 seconds. If a connection over the port specified by name remains idle after receiving data for specified number of seconds, it adds a Done-key. This implies the last event is completely received.
    restrictToHost String
    Allows for restricting this input to only accept data from the host specified here.
    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
    Set the source type for events from this input. "sourcetype=" is automatically prepended to . Defaults to audittrail (if signedaudit=true) or fschange (if signedaudit=false).

    Supporting Types

    InputsTcpRawAcl, InputsTcpRawAclArgs

    App string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite bool
    Indicates if the active user can edit this object. Defaults to true.
    Owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    Reads List<string>
    Properties that indicate resource read permissions.
    Removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    Sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    Writes List<string>
    Properties that indicate resource write permissions.
    App string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    CanChangePerms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    CanShareApp bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    CanShareGlobal bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    CanShareUser bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    CanWrite bool
    Indicates if the active user can edit this object. Defaults to true.
    Owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    Reads []string
    Properties that indicate resource read permissions.
    Removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    Sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    Writes []string
    Properties that indicate resource write permissions.
    app String
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite Boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner String
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads List<String>
    Properties that indicate resource read permissions.
    removable Boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing String
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes List<String>
    Properties that indicate resource write permissions.
    app string
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner string
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads string[]
    Properties that indicate resource read permissions.
    removable boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing string
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes string[]
    Properties that indicate resource write permissions.
    app str
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    can_change_perms bool
    Indicates if the active user can change permissions for this object. Defaults to true.
    can_share_app bool
    Indicates if the active user can change sharing to app level. Defaults to true.
    can_share_global bool
    Indicates if the active user can change sharing to system level. Defaults to true.
    can_share_user bool
    Indicates if the active user can change sharing to user level. Defaults to true.
    can_write bool
    Indicates if the active user can edit this object. Defaults to true.
    owner str
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads Sequence[str]
    Properties that indicate resource read permissions.
    removable bool
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing str
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes Sequence[str]
    Properties that indicate resource write permissions.
    app String
    The app context for the resource. Required for updating saved search ACL properties. Allowed values are:The name of an app and system
    canChangePerms Boolean
    Indicates if the active user can change permissions for this object. Defaults to true.
    canShareApp Boolean
    Indicates if the active user can change sharing to app level. Defaults to true.
    canShareGlobal Boolean
    Indicates if the active user can change sharing to system level. Defaults to true.
    canShareUser Boolean
    Indicates if the active user can change sharing to user level. Defaults to true.
    canWrite Boolean
    Indicates if the active user can edit this object. Defaults to true.
    owner String
    User name of resource owner. Defaults to the resource creator. Required for updating any knowledge object ACL properties.nobody = All users may access the resource, but write access to the resource might be restricted.
    reads List<String>
    Properties that indicate resource read permissions.
    removable Boolean
    Indicates whether an admin or user with sufficient permissions can delete the entity.
    sharing String
    Indicates how the resource is shared. Required for updating any knowledge object ACL properties.app: Shared within a specific appglobal: (Default) Shared globally to all apps.user: Private to a user
    writes List<String>
    Properties that indicate 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 logo
    Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-splunk