1. Packages
  2. Splunk Provider
  3. API Docs
  4. GlobalHttpEventCollector
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi

splunk.GlobalHttpEventCollector

Explore with Pulumi AI

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

    # Resource: splunk.GlobalHttpEventCollector

    Update Global HTTP Event Collector input configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as splunk from "@pulumi/splunk";
    
    const http = new splunk.GlobalHttpEventCollector("http", {
        disabled: false,
        enableSsl: true,
        port: 8088,
    });
    
    import pulumi
    import pulumi_splunk as splunk
    
    http = splunk.GlobalHttpEventCollector("http",
        disabled=False,
        enable_ssl=True,
        port=8088)
    
    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.NewGlobalHttpEventCollector(ctx, "http", &splunk.GlobalHttpEventCollectorArgs{
    			Disabled:  pulumi.Bool(false),
    			EnableSsl: pulumi.Bool(true),
    			Port:      pulumi.Int(8088),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Splunk = Pulumi.Splunk;
    
    return await Deployment.RunAsync(() => 
    {
        var http = new Splunk.GlobalHttpEventCollector("http", new()
        {
            Disabled = false,
            EnableSsl = true,
            Port = 8088,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.splunk.GlobalHttpEventCollector;
    import com.pulumi.splunk.GlobalHttpEventCollectorArgs;
    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 http = new GlobalHttpEventCollector("http", GlobalHttpEventCollectorArgs.builder()
                .disabled(false)
                .enableSsl(true)
                .port(8088)
                .build());
    
        }
    }
    
    resources:
      http:
        type: splunk:GlobalHttpEventCollector
        properties:
          disabled: false
          enableSsl: true
          port: 8088
    

    Create GlobalHttpEventCollector Resource

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

    Constructor syntax

    new GlobalHttpEventCollector(name: string, args?: GlobalHttpEventCollectorArgs, opts?: CustomResourceOptions);
    @overload
    def GlobalHttpEventCollector(resource_name: str,
                                 args: Optional[GlobalHttpEventCollectorArgs] = None,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def GlobalHttpEventCollector(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 dedicated_io_threads: Optional[int] = None,
                                 disabled: Optional[bool] = None,
                                 enable_ssl: Optional[bool] = None,
                                 max_sockets: Optional[int] = None,
                                 max_threads: Optional[int] = None,
                                 port: Optional[int] = None,
                                 use_deployment_server: Optional[int] = None)
    func NewGlobalHttpEventCollector(ctx *Context, name string, args *GlobalHttpEventCollectorArgs, opts ...ResourceOption) (*GlobalHttpEventCollector, error)
    public GlobalHttpEventCollector(string name, GlobalHttpEventCollectorArgs? args = null, CustomResourceOptions? opts = null)
    public GlobalHttpEventCollector(String name, GlobalHttpEventCollectorArgs args)
    public GlobalHttpEventCollector(String name, GlobalHttpEventCollectorArgs args, CustomResourceOptions options)
    
    type: splunk:GlobalHttpEventCollector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GlobalHttpEventCollectorArgs
    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 GlobalHttpEventCollectorArgs
    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 GlobalHttpEventCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalHttpEventCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalHttpEventCollectorArgs
    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 globalHttpEventCollectorResource = new Splunk.GlobalHttpEventCollector("globalHttpEventCollectorResource", new()
    {
        DedicatedIoThreads = 0,
        Disabled = false,
        EnableSsl = false,
        MaxSockets = 0,
        MaxThreads = 0,
        Port = 0,
        UseDeploymentServer = 0,
    });
    
    example, err := splunk.NewGlobalHttpEventCollector(ctx, "globalHttpEventCollectorResource", &splunk.GlobalHttpEventCollectorArgs{
    	DedicatedIoThreads:  pulumi.Int(0),
    	Disabled:            pulumi.Bool(false),
    	EnableSsl:           pulumi.Bool(false),
    	MaxSockets:          pulumi.Int(0),
    	MaxThreads:          pulumi.Int(0),
    	Port:                pulumi.Int(0),
    	UseDeploymentServer: pulumi.Int(0),
    })
    
    var globalHttpEventCollectorResource = new GlobalHttpEventCollector("globalHttpEventCollectorResource", GlobalHttpEventCollectorArgs.builder()
        .dedicatedIoThreads(0)
        .disabled(false)
        .enableSsl(false)
        .maxSockets(0)
        .maxThreads(0)
        .port(0)
        .useDeploymentServer(0)
        .build());
    
    global_http_event_collector_resource = splunk.GlobalHttpEventCollector("globalHttpEventCollectorResource",
        dedicated_io_threads=0,
        disabled=False,
        enable_ssl=False,
        max_sockets=0,
        max_threads=0,
        port=0,
        use_deployment_server=0)
    
    const globalHttpEventCollectorResource = new splunk.GlobalHttpEventCollector("globalHttpEventCollectorResource", {
        dedicatedIoThreads: 0,
        disabled: false,
        enableSsl: false,
        maxSockets: 0,
        maxThreads: 0,
        port: 0,
        useDeploymentServer: 0,
    });
    
    type: splunk:GlobalHttpEventCollector
    properties:
        dedicatedIoThreads: 0
        disabled: false
        enableSsl: false
        maxSockets: 0
        maxThreads: 0
        port: 0
        useDeploymentServer: 0
    

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

    DedicatedIoThreads int
    Number of threads used by HTTP Input server.
    Disabled bool
    Input disabled indicator.
    EnableSsl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    MaxSockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    MaxThreads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    Port int
    HTTP data input IP port.
    UseDeploymentServer int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    DedicatedIoThreads int
    Number of threads used by HTTP Input server.
    Disabled bool
    Input disabled indicator.
    EnableSsl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    MaxSockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    MaxThreads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    Port int
    HTTP data input IP port.
    UseDeploymentServer int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads Integer
    Number of threads used by HTTP Input server.
    disabled Boolean
    Input disabled indicator.
    enableSsl Boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets Integer
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads Integer
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port Integer
    HTTP data input IP port.
    useDeploymentServer Integer
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads number
    Number of threads used by HTTP Input server.
    disabled boolean
    Input disabled indicator.
    enableSsl boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets number
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads number
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port number
    HTTP data input IP port.
    useDeploymentServer number
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicated_io_threads int
    Number of threads used by HTTP Input server.
    disabled bool
    Input disabled indicator.
    enable_ssl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    max_sockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    max_threads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port int
    HTTP data input IP port.
    use_deployment_server int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads Number
    Number of threads used by HTTP Input server.
    disabled Boolean
    Input disabled indicator.
    enableSsl Boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets Number
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads Number
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port Number
    HTTP data input IP port.
    useDeploymentServer Number
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).

    Outputs

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

    Get an existing GlobalHttpEventCollector 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?: GlobalHttpEventCollectorState, opts?: CustomResourceOptions): GlobalHttpEventCollector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dedicated_io_threads: Optional[int] = None,
            disabled: Optional[bool] = None,
            enable_ssl: Optional[bool] = None,
            max_sockets: Optional[int] = None,
            max_threads: Optional[int] = None,
            port: Optional[int] = None,
            use_deployment_server: Optional[int] = None) -> GlobalHttpEventCollector
    func GetGlobalHttpEventCollector(ctx *Context, name string, id IDInput, state *GlobalHttpEventCollectorState, opts ...ResourceOption) (*GlobalHttpEventCollector, error)
    public static GlobalHttpEventCollector Get(string name, Input<string> id, GlobalHttpEventCollectorState? state, CustomResourceOptions? opts = null)
    public static GlobalHttpEventCollector get(String name, Output<String> id, GlobalHttpEventCollectorState 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:
    DedicatedIoThreads int
    Number of threads used by HTTP Input server.
    Disabled bool
    Input disabled indicator.
    EnableSsl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    MaxSockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    MaxThreads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    Port int
    HTTP data input IP port.
    UseDeploymentServer int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    DedicatedIoThreads int
    Number of threads used by HTTP Input server.
    Disabled bool
    Input disabled indicator.
    EnableSsl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    MaxSockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    MaxThreads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    Port int
    HTTP data input IP port.
    UseDeploymentServer int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads Integer
    Number of threads used by HTTP Input server.
    disabled Boolean
    Input disabled indicator.
    enableSsl Boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets Integer
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads Integer
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port Integer
    HTTP data input IP port.
    useDeploymentServer Integer
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads number
    Number of threads used by HTTP Input server.
    disabled boolean
    Input disabled indicator.
    enableSsl boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets number
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads number
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port number
    HTTP data input IP port.
    useDeploymentServer number
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicated_io_threads int
    Number of threads used by HTTP Input server.
    disabled bool
    Input disabled indicator.
    enable_ssl bool
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    max_sockets int
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    max_threads int
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port int
    HTTP data input IP port.
    use_deployment_server int
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).
    dedicatedIoThreads Number
    Number of threads used by HTTP Input server.
    disabled Boolean
    Input disabled indicator.
    enableSsl Boolean
    Enable SSL protocol for HTTP data input. true = SSL enabled, false = SSL disabled.
    maxSockets Number
    Maximum number of simultaneous HTTP connections accepted. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    maxThreads Number
    Maximum number of threads that can be used by active HTTP transactions. Adjusting this value may cause server performance issues and is not generally recommended. Possible values for this setting vary by OS.
    port Number
    HTTP data input IP port.
    useDeploymentServer Number
    Indicates whether the event collector input writes its configuration to a deployment server repository. When this setting is set to 1 (enabled), the input writes its configuration to the directory specified as repositoryLocation in serverclass.conf. Copy the full contents of the splunk_httpinput app directory to this directory for the configuration to work. When enabled, only the tokens defined in the splunk_httpinput app in this repository are viewable and editable on the API and the Data Inputs page in Splunk Web. When disabled, the input writes its configuration to $SPLUNK_HOME/etc/apps by default. Defaults to 0 (disabled).

    Package Details

    Repository
    Splunk pulumi/pulumi-splunk
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splunk Terraform Provider.
    splunk logo
    Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi