Splunk v1.2.4, Aug 24 23

Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi

splunk.OutputsTcpGroup

Explore with Pulumi AI

Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi

pulumi/pulumi-splunk

# Resource: splunk.OutputsTcpGroup

Access to the configuration of a group of one or more data forwarding destinations.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var tcpGroup = new Splunk.OutputsTcpGroup("tcpGroup", new()
    {
        Disabled = false,
        DropEventsOnQueueFull = 60,
        MaxQueueSize = "100KB",
        SendCookedData = true,
        Servers = new[]
        {
            "1.1.1.1:1234",
            "2.2.2.2:1234",
        },
    });

});

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.NewOutputsTcpGroup(ctx, "tcpGroup", &splunk.OutputsTcpGroupArgs{
			Disabled:              pulumi.Bool(false),
			DropEventsOnQueueFull: pulumi.Int(60),
			MaxQueueSize:          pulumi.String("100KB"),
			SendCookedData:        pulumi.Bool(true),
			Servers: pulumi.StringArray{
				pulumi.String("1.1.1.1:1234"),
				pulumi.String("2.2.2.2:1234"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.OutputsTcpGroup;
import com.pulumi.splunk.OutputsTcpGroupArgs;
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 tcpGroup = new OutputsTcpGroup("tcpGroup", OutputsTcpGroupArgs.builder()        
            .disabled(false)
            .dropEventsOnQueueFull(60)
            .maxQueueSize("100KB")
            .sendCookedData(true)
            .servers(            
                "1.1.1.1:1234",
                "2.2.2.2:1234")
            .build());

    }
}

import pulumi
import pulumi_splunk as splunk

tcp_group = splunk.OutputsTcpGroup("tcpGroup",
    disabled=False,
    drop_events_on_queue_full=60,
    max_queue_size="100KB",
    send_cooked_data=True,
    servers=[
        "1.1.1.1:1234",
        "2.2.2.2:1234",
    ])

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

const tcpGroup = new splunk.OutputsTcpGroup("tcpGroup", {
    disabled: false,
    dropEventsOnQueueFull: 60,
    maxQueueSize: "100KB",
    sendCookedData: true,
    servers: [
        "1.1.1.1:1234",
        "2.2.2.2:1234",
    ],
});

resources:
  tcpGroup:
    type: splunk:OutputsTcpGroup
    properties:
      disabled: false
      dropEventsOnQueueFull: 60
      maxQueueSize: 100KB
      sendCookedData: true
      servers:
        - 1.1.1.1:1234
        - 2.2.2.2:1234

Create OutputsTcpGroup Resource

new OutputsTcpGroup(name: string, args: OutputsTcpGroupArgs, opts?: CustomResourceOptions);

@overload
def OutputsTcpGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    acl: Optional[OutputsTcpGroupAclArgs] = None,
                    compressed: Optional[bool] = None,
                    disabled: Optional[bool] = None,
                    drop_events_on_queue_full: Optional[int] = None,
                    heartbeat_frequency: Optional[int] = None,
                    max_queue_size: Optional[str] = None,
                    method: Optional[str] = None,
                    name: Optional[str] = None,
                    send_cooked_data: Optional[bool] = None,
                    servers: Optional[Sequence[str]] = None,
                    token: Optional[str] = None)
@overload
def OutputsTcpGroup(resource_name: str,
                    args: OutputsTcpGroupArgs,
                    opts: Optional[ResourceOptions] = None)

func NewOutputsTcpGroup(ctx *Context, name string, args OutputsTcpGroupArgs, opts ...ResourceOption) (*OutputsTcpGroup, error)

public OutputsTcpGroup(string name, OutputsTcpGroupArgs args, CustomResourceOptions? opts = null)

public OutputsTcpGroup(String name, OutputsTcpGroupArgs args)
public OutputsTcpGroup(String name, OutputsTcpGroupArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args OutputsTcpGroupArgs: 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 OutputsTcpGroupArgs: 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 OutputsTcpGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OutputsTcpGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OutputsTcpGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

OutputsTcpGroup Resource Properties

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

Inputs

The OutputsTcpGroup resource accepts the following input properties:

Servers List<string>: Comma-separated list of servers to include in the group.
Acl OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
Compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
Disabled bool: If true, disables the group.
DropEventsOnQueueFull int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
HeartbeatFrequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
MaxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
Method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
Name string: The name of the group of receivers.
SendCookedData bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
Token string: Token value generated by the indexer after configuration.

Servers []string: Comma-separated list of servers to include in the group.
Acl OutputsTcpGroupAclArgs: The app/user context that is the namespace for the resource
Compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
Disabled bool: If true, disables the group.
DropEventsOnQueueFull int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
HeartbeatFrequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
MaxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
Method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
Name string: The name of the group of receivers.
SendCookedData bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
Token string: Token value generated by the indexer after configuration.

servers List<String>: Comma-separated list of servers to include in the group.
acl OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
compressed Boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled Boolean: If true, disables the group.
dropEventsOnQueueFull Integer: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency Integer: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize String: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method String: Valid values: (tcpout | syslog). Specifies the type of output processor.
name String: The name of the group of receivers.
sendCookedData Boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
token String: Token value generated by the indexer after configuration.

servers string[]: Comma-separated list of servers to include in the group.
acl OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
compressed boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled boolean: If true, disables the group.
dropEventsOnQueueFull number: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency number: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
name string: The name of the group of receivers.
sendCookedData boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
token string: Token value generated by the indexer after configuration.

servers Sequence[str]: Comma-separated list of servers to include in the group.
acl OutputsTcpGroupAclArgs: The app/user context that is the namespace for the resource
compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled bool: If true, disables the group.
drop_events_on_queue_full int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeat_frequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
max_queue_size str: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method str: Valid values: (tcpout | syslog). Specifies the type of output processor.
name str: The name of the group of receivers.
send_cooked_data bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
token str: Token value generated by the indexer after configuration.

servers List<String>: Comma-separated list of servers to include in the group.
acl Property Map: The app/user context that is the namespace for the resource
compressed Boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled Boolean: If true, disables the group.
dropEventsOnQueueFull Number: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency Number: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize String: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method String: Valid values: (tcpout | syslog). Specifies the type of output processor.
name String: The name of the group of receivers.
sendCookedData Boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
token String: Token value generated by the indexer after configuration.

Outputs

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

Get an existing OutputsTcpGroup 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?: OutputsTcpGroupState, opts?: CustomResourceOptions): OutputsTcpGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[OutputsTcpGroupAclArgs] = None,
        compressed: Optional[bool] = None,
        disabled: Optional[bool] = None,
        drop_events_on_queue_full: Optional[int] = None,
        heartbeat_frequency: Optional[int] = None,
        max_queue_size: Optional[str] = None,
        method: Optional[str] = None,
        name: Optional[str] = None,
        send_cooked_data: Optional[bool] = None,
        servers: Optional[Sequence[str]] = None,
        token: Optional[str] = None) -> OutputsTcpGroup

func GetOutputsTcpGroup(ctx *Context, name string, id IDInput, state *OutputsTcpGroupState, opts ...ResourceOption) (*OutputsTcpGroup, error)

public static OutputsTcpGroup Get(string name, Input<string> id, OutputsTcpGroupState? state, CustomResourceOptions? opts = null)

public static OutputsTcpGroup get(String name, Output<String> id, OutputsTcpGroupState 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 OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
Compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
Disabled bool: If true, disables the group.
DropEventsOnQueueFull int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
HeartbeatFrequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
MaxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
Method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
Name string: The name of the group of receivers.
SendCookedData bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
Servers List<string>: Comma-separated list of servers to include in the group.
Token string: Token value generated by the indexer after configuration.

Acl OutputsTcpGroupAclArgs: The app/user context that is the namespace for the resource
Compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
Disabled bool: If true, disables the group.
DropEventsOnQueueFull int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
HeartbeatFrequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
MaxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
Method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
Name string: The name of the group of receivers.
SendCookedData bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
Servers []string: Comma-separated list of servers to include in the group.
Token string: Token value generated by the indexer after configuration.

acl OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
compressed Boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled Boolean: If true, disables the group.
dropEventsOnQueueFull Integer: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency Integer: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize String: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method String: Valid values: (tcpout | syslog). Specifies the type of output processor.
name String: The name of the group of receivers.
sendCookedData Boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
servers List<String>: Comma-separated list of servers to include in the group.
token String: Token value generated by the indexer after configuration.

acl OutputsTcpGroupAcl: The app/user context that is the namespace for the resource
compressed boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled boolean: If true, disables the group.
dropEventsOnQueueFull number: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency number: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize string: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method string: Valid values: (tcpout | syslog). Specifies the type of output processor.
name string: The name of the group of receivers.
sendCookedData boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
servers string[]: Comma-separated list of servers to include in the group.
token string: Token value generated by the indexer after configuration.

acl OutputsTcpGroupAclArgs: The app/user context that is the namespace for the resource
compressed bool: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled bool: If true, disables the group.
drop_events_on_queue_full int: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeat_frequency int: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
max_queue_size str: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method str: Valid values: (tcpout | syslog). Specifies the type of output processor.
name str: The name of the group of receivers.
send_cooked_data bool: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
servers Sequence[str]: Comma-separated list of servers to include in the group.
token str: Token value generated by the indexer after configuration.

acl Property Map: The app/user context that is the namespace for the resource
compressed Boolean: If true, forwarder sends compressed data. If set to true, the receiver port must also have compression turned on.
disabled Boolean: If true, disables the group.
dropEventsOnQueueFull Number: If set to a positive number, wait the specified number of seconds before throwing out all new events until the output queue has space. Defaults to -1 (do not drop events). CAUTION: Do not set this value to a positive integer if you are monitoring files. Setting this to -1 or 0 causes the output queue to block when it gets full, which causes further blocking up the processing chain. If any target group queue is blocked, no more data reaches any other target group. Using auto load-balancing is the best way to minimize this condition, because, in that case, multiple receivers must be down (or jammed up) before queue blocking can occur.
heartbeatFrequency Number: How often (in seconds) to send a heartbeat packet to the receiving server. Heartbeats are only sent if sendCookedData=true. Defaults to 30 seconds.
maxQueueSize String: Specify an integer or integer[KB|MB|GB]. Sets the maximum size of the forwarder output queue. It also sets the maximum size of the wait queue to 3x this value, if you have enabled indexer acknowledgment (useACK=true). Although the wait queue and the output queues are both configured by this attribute, they are separate queues. The setting determines the maximum size of the queue in-memory (RAM) buffer. For heavy forwarders sending parsed data, maxQueueSize is the maximum number of events. Since events are typically much shorter than data blocks, the memory consumed by the queue on a parsing forwarder is likely to be much smaller than on a non-parsing forwarder, if you use this version of the setting. If specified as a lone integer (for example, maxQueueSize=100), maxQueueSize indicates the maximum number of queued events (for parsed data) or blocks of data (for unparsed data). A block of data is approximately 64KB. For non-parsing forwarders, such as universal forwarders, that send unparsed data, maxQueueSize is the maximum number of data blocks. If specified as an integer followed by KB, MB, or GB (for example, maxQueueSize=100MB), maxQueueSize indicates the maximum RAM allocated to the queue buffer. Defaults to 500KB (which means a maximum size of 500KB for the output queue and 1500KB for the wait queue, if any).
method String: Valid values: (tcpout | syslog). Specifies the type of output processor.
name String: The name of the group of receivers.
sendCookedData Boolean: If true, events are cooked (processed by Splunk software). If false, events are raw and untouched prior to sending. Defaults to true. Set to false if you are sending to a third-party system.
servers List<String>: Comma-separated list of servers to include in the group.
token String: Token value generated by the indexer after configuration.

Supporting Types

OutputsTcpGroupAcl, OutputsTcpGroupAclArgs

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 List<String>
removable Boolean
sharing String
writes List<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]

app String
canChangePerms Boolean
canShareApp Boolean
canShareGlobal Boolean
canShareUser Boolean
canWrite Boolean
owner String
reads List<String>
removable Boolean
sharing String
writes List<String>

Package Details

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

Splunk v1.2.4 published on Thursday, Aug 24, 2023 by Pulumi

pulumi/pulumi-splunk

splunk.OutputsTcpGroup

On this page

On this page

# Resource: splunk.OutputsTcpGroup

Example Usage

Create OutputsTcpGroup Resource

OutputsTcpGroup Resource Properties

Inputs

Outputs

Look up Existing OutputsTcpGroup Resource

Supporting Types

OutputsTcpGroupAcl, OutputsTcpGroupAclArgs

Package Details

On this page

On this page