Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splunk Provider
  3. API Docs
  4. OutputsTcpDefault
Splunk v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk

splunk.OutputsTcpDefault

Explore with Pulumi AI

Splunk v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk

# Resource: splunk.OutputsTcpDefault

Manage to global tcpout properties.

Example Usage

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

const tcpDefault = new splunk.OutputsTcpDefault("tcp_default", {
    name: "tcpout",
    disabled: false,
    defaultGroup: "test-indexers",
    dropEventsOnQueueFull: 60,
    indexAndForward: true,
    sendCookedData: true,
    maxQueueSize: "100KB",
});
Copy
import pulumi
import pulumi_splunk as splunk

tcp_default = splunk.OutputsTcpDefault("tcp_default",
    name="tcpout",
    disabled=False,
    default_group="test-indexers",
    drop_events_on_queue_full=60,
    index_and_forward=True,
    send_cooked_data=True,
    max_queue_size="100KB")
Copy
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.NewOutputsTcpDefault(ctx, "tcp_default", &splunk.OutputsTcpDefaultArgs{
			Name:                  pulumi.String("tcpout"),
			Disabled:              pulumi.Bool(false),
			DefaultGroup:          pulumi.String("test-indexers"),
			DropEventsOnQueueFull: pulumi.Int(60),
			IndexAndForward:       pulumi.Bool(true),
			SendCookedData:        pulumi.Bool(true),
			MaxQueueSize:          pulumi.String("100KB"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Splunk = Pulumi.Splunk;

return await Deployment.RunAsync(() => 
{
    var tcpDefault = new Splunk.OutputsTcpDefault("tcp_default", new()
    {
        Name = "tcpout",
        Disabled = false,
        DefaultGroup = "test-indexers",
        DropEventsOnQueueFull = 60,
        IndexAndForward = true,
        SendCookedData = true,
        MaxQueueSize = "100KB",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.OutputsTcpDefault;
import com.pulumi.splunk.OutputsTcpDefaultArgs;
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 tcpDefault = new OutputsTcpDefault("tcpDefault", OutputsTcpDefaultArgs.builder()
            .name("tcpout")
            .disabled(false)
            .defaultGroup("test-indexers")
            .dropEventsOnQueueFull(60)
            .indexAndForward(true)
            .sendCookedData(true)
            .maxQueueSize("100KB")
            .build());

    }
}
Copy
resources:
  tcpDefault:
    type: splunk:OutputsTcpDefault
    name: tcp_default
    properties:
      name: tcpout
      disabled: false
      defaultGroup: test-indexers
      dropEventsOnQueueFull: 60
      indexAndForward: true
      sendCookedData: true
      maxQueueSize: 100KB
Copy

Create OutputsTcpDefault Resource

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

Constructor syntax

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

@overload
def OutputsTcpDefault(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      acl: Optional[OutputsTcpDefaultAclArgs] = None,
                      default_group: Optional[str] = None,
                      disabled: Optional[bool] = None,
                      drop_events_on_queue_full: Optional[int] = None,
                      heartbeat_frequency: Optional[int] = None,
                      index_and_forward: Optional[bool] = None,
                      max_queue_size: Optional[str] = None,
                      name: Optional[str] = None,
                      send_cooked_data: Optional[bool] = None)
func NewOutputsTcpDefault(ctx *Context, name string, args *OutputsTcpDefaultArgs, opts ...ResourceOption) (*OutputsTcpDefault, error)
public OutputsTcpDefault(string name, OutputsTcpDefaultArgs? args = null, CustomResourceOptions? opts = null)
public OutputsTcpDefault(String name, OutputsTcpDefaultArgs args)
public OutputsTcpDefault(String name, OutputsTcpDefaultArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args OutputsTcpDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OutputsTcpDefaultArgs
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 outputsTcpDefaultResource = new Splunk.OutputsTcpDefault("outputsTcpDefaultResource", new()
{
    Acl = new Splunk.Inputs.OutputsTcpDefaultAclArgs
    {
        App = "string",
        CanChangePerms = false,
        CanShareApp = false,
        CanShareGlobal = false,
        CanShareUser = false,
        CanWrite = false,
        Owner = "string",
        Reads = new[]
        {
            "string",
        },
        Removable = false,
        Sharing = "string",
        Writes = new[]
        {
            "string",
        },
    },
    DefaultGroup = "string",
    Disabled = false,
    DropEventsOnQueueFull = 0,
    HeartbeatFrequency = 0,
    IndexAndForward = false,
    MaxQueueSize = "string",
    Name = "string",
    SendCookedData = false,
});
Copy
example, err := splunk.NewOutputsTcpDefault(ctx, "outputsTcpDefaultResource", &splunk.OutputsTcpDefaultArgs{
	Acl: &splunk.OutputsTcpDefaultAclArgs{
		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"),
		},
	},
	DefaultGroup:          pulumi.String("string"),
	Disabled:              pulumi.Bool(false),
	DropEventsOnQueueFull: pulumi.Int(0),
	HeartbeatFrequency:    pulumi.Int(0),
	IndexAndForward:       pulumi.Bool(false),
	MaxQueueSize:          pulumi.String("string"),
	Name:                  pulumi.String("string"),
	SendCookedData:        pulumi.Bool(false),
})
Copy
var outputsTcpDefaultResource = new OutputsTcpDefault("outputsTcpDefaultResource", OutputsTcpDefaultArgs.builder()
    .acl(OutputsTcpDefaultAclArgs.builder()
        .app("string")
        .canChangePerms(false)
        .canShareApp(false)
        .canShareGlobal(false)
        .canShareUser(false)
        .canWrite(false)
        .owner("string")
        .reads("string")
        .removable(false)
        .sharing("string")
        .writes("string")
        .build())
    .defaultGroup("string")
    .disabled(false)
    .dropEventsOnQueueFull(0)
    .heartbeatFrequency(0)
    .indexAndForward(false)
    .maxQueueSize("string")
    .name("string")
    .sendCookedData(false)
    .build());
Copy
outputs_tcp_default_resource = splunk.OutputsTcpDefault("outputsTcpDefaultResource",
    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"],
    },
    default_group="string",
    disabled=False,
    drop_events_on_queue_full=0,
    heartbeat_frequency=0,
    index_and_forward=False,
    max_queue_size="string",
    name="string",
    send_cooked_data=False)
Copy
const outputsTcpDefaultResource = new splunk.OutputsTcpDefault("outputsTcpDefaultResource", {
    acl: {
        app: "string",
        canChangePerms: false,
        canShareApp: false,
        canShareGlobal: false,
        canShareUser: false,
        canWrite: false,
        owner: "string",
        reads: ["string"],
        removable: false,
        sharing: "string",
        writes: ["string"],
    },
    defaultGroup: "string",
    disabled: false,
    dropEventsOnQueueFull: 0,
    heartbeatFrequency: 0,
    indexAndForward: false,
    maxQueueSize: "string",
    name: "string",
    sendCookedData: false,
});
Copy
type: splunk:OutputsTcpDefault
properties:
    acl:
        app: string
        canChangePerms: false
        canShareApp: false
        canShareGlobal: false
        canShareUser: false
        canWrite: false
        owner: string
        reads:
            - string
        removable: false
        sharing: string
        writes:
            - string
    defaultGroup: string
    disabled: false
    dropEventsOnQueueFull: 0
    heartbeatFrequency: 0
    indexAndForward: false
    maxQueueSize: string
    name: string
    sendCookedData: false
Copy

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

Acl OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
DefaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
Disabled bool
Disables default tcpout settings
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.
IndexAndForward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
Name string
Configuration to be edited. The only valid value is "tcpout".
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.
Acl OutputsTcpDefaultAclArgs
The app/user context that is the namespace for the resource
DefaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
Disabled bool
Disables default tcpout settings
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.
IndexAndForward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
Name string
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
defaultGroup String
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled Boolean
Disables default tcpout settings
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.
indexAndForward Boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name String
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
defaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled boolean
Disables default tcpout settings
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.
indexAndForward boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name string
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAclArgs
The app/user context that is the namespace for the resource
default_group str
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled bool
Disables default tcpout settings
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.
index_and_forward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name str
Configuration to be edited. The only valid value is "tcpout".
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.
acl Property Map
The app/user context that is the namespace for the resource
defaultGroup String
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled Boolean
Disables default tcpout settings
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.
indexAndForward Boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name String
Configuration to be edited. The only valid value is "tcpout".
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.

Outputs

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

Get an existing OutputsTcpDefault 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?: OutputsTcpDefaultState, opts?: CustomResourceOptions): OutputsTcpDefault
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[OutputsTcpDefaultAclArgs] = None,
        default_group: Optional[str] = None,
        disabled: Optional[bool] = None,
        drop_events_on_queue_full: Optional[int] = None,
        heartbeat_frequency: Optional[int] = None,
        index_and_forward: Optional[bool] = None,
        max_queue_size: Optional[str] = None,
        name: Optional[str] = None,
        send_cooked_data: Optional[bool] = None) -> OutputsTcpDefault
func GetOutputsTcpDefault(ctx *Context, name string, id IDInput, state *OutputsTcpDefaultState, opts ...ResourceOption) (*OutputsTcpDefault, error)
public static OutputsTcpDefault Get(string name, Input<string> id, OutputsTcpDefaultState? state, CustomResourceOptions? opts = null)
public static OutputsTcpDefault get(String name, Output<String> id, OutputsTcpDefaultState state, CustomResourceOptions options)
resources:  _:    type: splunk:OutputsTcpDefault    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
DefaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
Disabled bool
Disables default tcpout settings
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.
IndexAndForward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
Name string
Configuration to be edited. The only valid value is "tcpout".
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.
Acl OutputsTcpDefaultAclArgs
The app/user context that is the namespace for the resource
DefaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
Disabled bool
Disables default tcpout settings
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.
IndexAndForward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
Name string
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
defaultGroup String
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled Boolean
Disables default tcpout settings
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.
indexAndForward Boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name String
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAcl
The app/user context that is the namespace for the resource
defaultGroup string
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled boolean
Disables default tcpout settings
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.
indexAndForward boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name string
Configuration to be edited. The only valid value is "tcpout".
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.
acl OutputsTcpDefaultAclArgs
The app/user context that is the namespace for the resource
default_group str
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled bool
Disables default tcpout settings
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.
index_and_forward bool
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name str
Configuration to be edited. The only valid value is "tcpout".
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.
acl Property Map
The app/user context that is the namespace for the resource
defaultGroup String
Comma-separated list of one or more target group names, specified later in [tcpout:<target_group>] stanzas of outputs.conf.spec file. The forwarder sends all data to the specified groups. If you do not want to forward data automatically, do not set this attribute. Can be overridden by an inputs.conf _TCP_ROUTING setting, which in turn can be overridden by a props.conf/transforms.conf modifier.
disabled Boolean
Disables default tcpout settings
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.
indexAndForward Boolean
Specifies whether to index all data locally, in addition to forwarding it. Defaults to false. This is known as an "index-and-forward" configuration. This attribute is only available for heavy forwarders. It is available only at the top level [tcpout] stanza in outputs.conf. It cannot be overridden in a target group.
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).
name String
Configuration to be edited. The only valid value is "tcpout".
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.

Supporting Types

OutputsTcpDefaultAcl
, OutputsTcpDefaultAclArgs

App Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 v1.2.17 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-splunk