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

InputsTcpRaw

# Resource: splunk.InputsTcpRaw

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

Example Usage

using Pulumi;
using Splunk = Pulumi.Splunk;

class MyStack : Stack
{
    public MyStack()
    {
        var tcpRaw = new Splunk.InputsTcpRaw("tcpRaw", new Splunk.InputsTcpRawArgs
        {
            Disabled = false,
            Index = "main",
            Queue = "indexQueue",
            Source = "new",
            Sourcetype = "new",
        });
    }

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

tcp_raw = splunk.InputsTcpRaw("tcpRaw",
    disabled=False,
    index="main",
    queue="indexQueue",
    source="new",
    sourcetype="new")
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

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

Create a InputsTcpRaw Resource

new InputsTcpRaw(name: string, args?: InputsTcpRawArgs, opts?: CustomResourceOptions);
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)
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.
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 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.

InputsTcpRaw Resource Properties

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

Inputs

The InputsTcpRaw resource accepts the following input properties:

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

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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)
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 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 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 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).

Supporting Types

InputsTcpRawAcl

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.