OutputsTcpSyslog
# Resource: splunk.OutputsTcpSyslog
Access the configuration of a forwarded server configured to provide data in standard syslog format.
Example Usage
using Pulumi;
using Splunk = Pulumi.Splunk;
class MyStack : Stack
{
public MyStack()
{
var tcpSyslog = new Splunk.OutputsTcpSyslog("tcpSyslog", new Splunk.OutputsTcpSyslogArgs
{
Priority = 5,
Server = "new-host-1:1234",
});
}
}
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.NewOutputsTcpSyslog(ctx, "tcpSyslog", &splunk.OutputsTcpSyslogArgs{
Priority: pulumi.Int(5),
Server: pulumi.String("new-host-1:1234"),
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_splunk as splunk
tcp_syslog = splunk.OutputsTcpSyslog("tcpSyslog",
priority=5,
server="new-host-1:1234")
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";
const tcpSyslog = new splunk.OutputsTcpSyslog("tcp_syslog", {
priority: 5,
server: "new-host-1:1234",
});
Create a OutputsTcpSyslog Resource
new OutputsTcpSyslog(name: string, args?: OutputsTcpSyslogArgs, opts?: CustomResourceOptions);
def OutputsTcpSyslog(resource_name: str, opts: Optional[ResourceOptions] = None, acl: Optional[OutputsTcpSyslogAclArgs] = None, disabled: Optional[bool] = None, name: Optional[str] = None, priority: Optional[int] = None, server: Optional[str] = None, syslog_sourcetype: Optional[str] = None, timestamp_format: Optional[str] = None, type: Optional[str] = None)
func NewOutputsTcpSyslog(ctx *Context, name string, args *OutputsTcpSyslogArgs, opts ...ResourceOption) (*OutputsTcpSyslog, error)
public OutputsTcpSyslog(string name, OutputsTcpSyslogArgs? args = null, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args OutputsTcpSyslogArgs
- 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 OutputsTcpSyslogArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OutputsTcpSyslogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
OutputsTcpSyslog Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The OutputsTcpSyslog resource accepts the following input properties:
- Acl
Outputs
Tcp Syslog Acl Args The app/user context that is the namespace for the resource
- Disabled bool
If true, disables global syslog settings.
- Name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- Priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Server string
host:port of the server where syslog data should be sent
- Syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- Timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- Acl
Outputs
Tcp Syslog Acl The app/user context that is the namespace for the resource
- Disabled bool
If true, disables global syslog settings.
- Name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- Priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Server string
host:port of the server where syslog data should be sent
- Syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- Timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- acl
Outputs
Tcp Syslog Acl The app/user context that is the namespace for the resource
- disabled boolean
If true, disables global syslog settings.
- name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- priority number
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- server string
host:port of the server where syslog data should be sent
- syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- acl
Outputs
Tcp Syslog Acl Args The app/user context that is the namespace for the resource
- disabled bool
If true, disables global syslog settings.
- name str
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- server str
host:port of the server where syslog data should be sent
- syslog_
sourcetype str Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- timestamp_
format str Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- type str
Protocol to use to send syslog data. Valid values: (tcp | udp ).
Outputs
All input properties are implicitly available as output properties. Additionally, the OutputsTcpSyslog 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 OutputsTcpSyslog Resource
Get an existing OutputsTcpSyslog 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?: OutputsTcpSyslogState, opts?: CustomResourceOptions): OutputsTcpSyslog
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, acl: Optional[OutputsTcpSyslogAclArgs] = None, disabled: Optional[bool] = None, name: Optional[str] = None, priority: Optional[int] = None, server: Optional[str] = None, syslog_sourcetype: Optional[str] = None, timestamp_format: Optional[str] = None, type: Optional[str] = None) -> OutputsTcpSyslog
func GetOutputsTcpSyslog(ctx *Context, name string, id IDInput, state *OutputsTcpSyslogState, opts ...ResourceOption) (*OutputsTcpSyslog, error)
public static OutputsTcpSyslog Get(string name, Input<string> id, OutputsTcpSyslogState? 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
Outputs
Tcp Syslog Acl Args The app/user context that is the namespace for the resource
- Disabled bool
If true, disables global syslog settings.
- Name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- Priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Server string
host:port of the server where syslog data should be sent
- Syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- Timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- Acl
Outputs
Tcp Syslog Acl The app/user context that is the namespace for the resource
- Disabled bool
If true, disables global syslog settings.
- Name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- Priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Server string
host:port of the server where syslog data should be sent
- Syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- Timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- Type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- acl
Outputs
Tcp Syslog Acl The app/user context that is the namespace for the resource
- disabled boolean
If true, disables global syslog settings.
- name string
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- priority number
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- server string
host:port of the server where syslog data should be sent
- syslog
Sourcetype string Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- timestamp
Format string Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- type string
Protocol to use to send syslog data. Valid values: (tcp | udp ).
- acl
Outputs
Tcp Syslog Acl Args The app/user context that is the namespace for the resource
- disabled bool
If true, disables global syslog settings.
- name str
Name of the syslog output group. This is name used when creating syslog configuration in outputs.conf.
- priority int
Sets syslog priority value. The priority value should specified as an integer. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- server str
host:port of the server where syslog data should be sent
- syslog_
sourcetype str Specifies a rule for handling data in addition to that provided by the “syslog” sourcetype. By default, there is no value for syslogSourceType.
This string is used as a substring match against the sourcetype key. For example, if the string is set to ‘syslog’, then all source types containing the string “syslog” receives this special treatment. To match a source type explicitly, use the pattern “sourcetype::sourcetype_name.” For example syslogSourcetype = sourcetype::apache_common Data that is “syslog” or matches this setting is assumed to already be in syslog format. Data that does not match the rules has a header, potentially a timestamp, and a hostname added to the front of the event. This is how Splunk software causes arbitrary log data to match syslog expectations.- timestamp_
format str Format of timestamp to add at start of the events to be forwarded. The format is a strftime-style timestamp formatting string. See $SPLUNK_HOME/etc/system/README/outputs.conf.spec for details.
- type str
Protocol to use to send syslog data. Valid values: (tcp | udp ).
Supporting Types
OutputsTcpSyslogAcl
Package Details
- Repository
- https://github.com/pulumi/pulumi-splunk
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
splunk
Terraform Provider.