1. Packages
  2. Splunk
  3. API Docs
  4. InputsHttpEventCollector
Splunk v1.2.6 published on Thursday, Mar 21, 2024 by Pulumi

splunk.InputsHttpEventCollector

Explore with Pulumi AI

splunk logo
Splunk v1.2.6 published on Thursday, Mar 21, 2024 by Pulumi

    # Resource: splunk.InputsHttpEventCollector

    Create or update HTTP Event Collector input configuration tokens.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as splunk from "@pulumi/splunk";
    
    const hec_token_01 = new splunk.InputsHttpEventCollector("hec-token-01", {
        acl: {
            owner: "user01",
            reads: ["admin"],
            sharing: "global",
            writes: ["admin"],
        },
        disabled: false,
        index: "main",
        indexes: [
            "main",
            "history",
            "summary",
        ],
        source: "new:source",
        sourcetype: "new:sourcetype",
        useAck: 0,
    });
    
    import pulumi
    import pulumi_splunk as splunk
    
    hec_token_01 = splunk.InputsHttpEventCollector("hec-token-01",
        acl=splunk.InputsHttpEventCollectorAclArgs(
            owner="user01",
            reads=["admin"],
            sharing="global",
            writes=["admin"],
        ),
        disabled=False,
        index="main",
        indexes=[
            "main",
            "history",
            "summary",
        ],
        source="new:source",
        sourcetype="new:sourcetype",
        use_ack=0)
    
    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.NewInputsHttpEventCollector(ctx, "hec-token-01", &splunk.InputsHttpEventCollectorArgs{
    			Acl: &splunk.InputsHttpEventCollectorAclArgs{
    				Owner: pulumi.String("user01"),
    				Reads: pulumi.StringArray{
    					pulumi.String("admin"),
    				},
    				Sharing: pulumi.String("global"),
    				Writes: pulumi.StringArray{
    					pulumi.String("admin"),
    				},
    			},
    			Disabled: pulumi.Bool(false),
    			Index:    pulumi.String("main"),
    			Indexes: pulumi.StringArray{
    				pulumi.String("main"),
    				pulumi.String("history"),
    				pulumi.String("summary"),
    			},
    			Source:     pulumi.String("new:source"),
    			Sourcetype: pulumi.String("new:sourcetype"),
    			UseAck:     pulumi.Int(0),
    		})
    		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 hec_token_01 = new Splunk.InputsHttpEventCollector("hec-token-01", new()
        {
            Acl = new Splunk.Inputs.InputsHttpEventCollectorAclArgs
            {
                Owner = "user01",
                Reads = new[]
                {
                    "admin",
                },
                Sharing = "global",
                Writes = new[]
                {
                    "admin",
                },
            },
            Disabled = false,
            Index = "main",
            Indexes = new[]
            {
                "main",
                "history",
                "summary",
            },
            Source = "new:source",
            Sourcetype = "new:sourcetype",
            UseAck = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.splunk.InputsHttpEventCollector;
    import com.pulumi.splunk.InputsHttpEventCollectorArgs;
    import com.pulumi.splunk.inputs.InputsHttpEventCollectorAclArgs;
    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 hec_token_01 = new InputsHttpEventCollector("hec-token-01", InputsHttpEventCollectorArgs.builder()        
                .acl(InputsHttpEventCollectorAclArgs.builder()
                    .owner("user01")
                    .reads("admin")
                    .sharing("global")
                    .writes("admin")
                    .build())
                .disabled(false)
                .index("main")
                .indexes(            
                    "main",
                    "history",
                    "summary")
                .source("new:source")
                .sourcetype("new:sourcetype")
                .useAck(0)
                .build());
    
        }
    }
    
    resources:
      hec-token-01:
        type: splunk:InputsHttpEventCollector
        properties:
          acl:
            owner: user01
            reads:
              - admin
            sharing: global
            writes:
              - admin
          disabled: false
          index: main
          indexes:
            - main
            - history
            - summary
          source: new:source
          sourcetype: new:sourcetype
          useAck: 0
    

    Create InputsHttpEventCollector Resource

    new InputsHttpEventCollector(name: string, args?: InputsHttpEventCollectorArgs, opts?: CustomResourceOptions);
    @overload
    def InputsHttpEventCollector(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 acl: Optional[InputsHttpEventCollectorAclArgs] = None,
                                 disabled: Optional[bool] = None,
                                 host: Optional[str] = None,
                                 index: Optional[str] = None,
                                 indexes: Optional[Sequence[str]] = None,
                                 name: Optional[str] = None,
                                 source: Optional[str] = None,
                                 sourcetype: Optional[str] = None,
                                 token: Optional[str] = None,
                                 use_ack: Optional[int] = None)
    @overload
    def InputsHttpEventCollector(resource_name: str,
                                 args: Optional[InputsHttpEventCollectorArgs] = None,
                                 opts: Optional[ResourceOptions] = None)
    func NewInputsHttpEventCollector(ctx *Context, name string, args *InputsHttpEventCollectorArgs, opts ...ResourceOption) (*InputsHttpEventCollector, error)
    public InputsHttpEventCollector(string name, InputsHttpEventCollectorArgs? args = null, CustomResourceOptions? opts = null)
    public InputsHttpEventCollector(String name, InputsHttpEventCollectorArgs args)
    public InputsHttpEventCollector(String name, InputsHttpEventCollectorArgs args, CustomResourceOptions options)
    
    type: splunk:InputsHttpEventCollector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args InputsHttpEventCollectorArgs
    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 InputsHttpEventCollectorArgs
    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 InputsHttpEventCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InputsHttpEventCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InputsHttpEventCollectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Acl InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    Disabled bool
    Input disabled indicator
    Host string
    Default host value for events with this token
    Index string
    Index to store generated events
    Indexes List<string>
    Set of indexes allowed for events with this token
    Name string
    Token name (inputs.conf key)
    Source string
    Default source for events with this token
    Sourcetype string
    Default source type for events with this token
    Token string
    Token value for sending data to collector/event endpoint
    UseAck int
    Indexer acknowledgement for this token
    Acl InputsHttpEventCollectorAclArgs
    The app/user context that is the namespace for the resource
    Disabled bool
    Input disabled indicator
    Host string
    Default host value for events with this token
    Index string
    Index to store generated events
    Indexes []string
    Set of indexes allowed for events with this token
    Name string
    Token name (inputs.conf key)
    Source string
    Default source for events with this token
    Sourcetype string
    Default source type for events with this token
    Token string
    Token value for sending data to collector/event endpoint
    UseAck int
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    disabled Boolean
    Input disabled indicator
    host String
    Default host value for events with this token
    index String
    Index to store generated events
    indexes List<String>
    Set of indexes allowed for events with this token
    name String
    Token name (inputs.conf key)
    source String
    Default source for events with this token
    sourcetype String
    Default source type for events with this token
    token String
    Token value for sending data to collector/event endpoint
    useAck Integer
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    disabled boolean
    Input disabled indicator
    host string
    Default host value for events with this token
    index string
    Index to store generated events
    indexes string[]
    Set of indexes allowed for events with this token
    name string
    Token name (inputs.conf key)
    source string
    Default source for events with this token
    sourcetype string
    Default source type for events with this token
    token string
    Token value for sending data to collector/event endpoint
    useAck number
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAclArgs
    The app/user context that is the namespace for the resource
    disabled bool
    Input disabled indicator
    host str
    Default host value for events with this token
    index str
    Index to store generated events
    indexes Sequence[str]
    Set of indexes allowed for events with this token
    name str
    Token name (inputs.conf key)
    source str
    Default source for events with this token
    sourcetype str
    Default source type for events with this token
    token str
    Token value for sending data to collector/event endpoint
    use_ack int
    Indexer acknowledgement for this token
    acl Property Map
    The app/user context that is the namespace for the resource
    disabled Boolean
    Input disabled indicator
    host String
    Default host value for events with this token
    index String
    Index to store generated events
    indexes List<String>
    Set of indexes allowed for events with this token
    name String
    Token name (inputs.conf key)
    source String
    Default source for events with this token
    sourcetype String
    Default source type for events with this token
    token String
    Token value for sending data to collector/event endpoint
    useAck Number
    Indexer acknowledgement for this token

    Outputs

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

    Get an existing InputsHttpEventCollector 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?: InputsHttpEventCollectorState, opts?: CustomResourceOptions): InputsHttpEventCollector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acl: Optional[InputsHttpEventCollectorAclArgs] = None,
            disabled: Optional[bool] = None,
            host: Optional[str] = None,
            index: Optional[str] = None,
            indexes: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            source: Optional[str] = None,
            sourcetype: Optional[str] = None,
            token: Optional[str] = None,
            use_ack: Optional[int] = None) -> InputsHttpEventCollector
    func GetInputsHttpEventCollector(ctx *Context, name string, id IDInput, state *InputsHttpEventCollectorState, opts ...ResourceOption) (*InputsHttpEventCollector, error)
    public static InputsHttpEventCollector Get(string name, Input<string> id, InputsHttpEventCollectorState? state, CustomResourceOptions? opts = null)
    public static InputsHttpEventCollector get(String name, Output<String> id, InputsHttpEventCollectorState 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 InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    Disabled bool
    Input disabled indicator
    Host string
    Default host value for events with this token
    Index string
    Index to store generated events
    Indexes List<string>
    Set of indexes allowed for events with this token
    Name string
    Token name (inputs.conf key)
    Source string
    Default source for events with this token
    Sourcetype string
    Default source type for events with this token
    Token string
    Token value for sending data to collector/event endpoint
    UseAck int
    Indexer acknowledgement for this token
    Acl InputsHttpEventCollectorAclArgs
    The app/user context that is the namespace for the resource
    Disabled bool
    Input disabled indicator
    Host string
    Default host value for events with this token
    Index string
    Index to store generated events
    Indexes []string
    Set of indexes allowed for events with this token
    Name string
    Token name (inputs.conf key)
    Source string
    Default source for events with this token
    Sourcetype string
    Default source type for events with this token
    Token string
    Token value for sending data to collector/event endpoint
    UseAck int
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    disabled Boolean
    Input disabled indicator
    host String
    Default host value for events with this token
    index String
    Index to store generated events
    indexes List<String>
    Set of indexes allowed for events with this token
    name String
    Token name (inputs.conf key)
    source String
    Default source for events with this token
    sourcetype String
    Default source type for events with this token
    token String
    Token value for sending data to collector/event endpoint
    useAck Integer
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAcl
    The app/user context that is the namespace for the resource
    disabled boolean
    Input disabled indicator
    host string
    Default host value for events with this token
    index string
    Index to store generated events
    indexes string[]
    Set of indexes allowed for events with this token
    name string
    Token name (inputs.conf key)
    source string
    Default source for events with this token
    sourcetype string
    Default source type for events with this token
    token string
    Token value for sending data to collector/event endpoint
    useAck number
    Indexer acknowledgement for this token
    acl InputsHttpEventCollectorAclArgs
    The app/user context that is the namespace for the resource
    disabled bool
    Input disabled indicator
    host str
    Default host value for events with this token
    index str
    Index to store generated events
    indexes Sequence[str]
    Set of indexes allowed for events with this token
    name str
    Token name (inputs.conf key)
    source str
    Default source for events with this token
    sourcetype str
    Default source type for events with this token
    token str
    Token value for sending data to collector/event endpoint
    use_ack int
    Indexer acknowledgement for this token
    acl Property Map
    The app/user context that is the namespace for the resource
    disabled Boolean
    Input disabled indicator
    host String
    Default host value for events with this token
    index String
    Index to store generated events
    indexes List<String>
    Set of indexes allowed for events with this token
    name String
    Token name (inputs.conf key)
    source String
    Default source for events with this token
    sourcetype String
    Default source type for events with this token
    token String
    Token value for sending data to collector/event endpoint
    useAck Number
    Indexer acknowledgement for this token

    Supporting Types

    InputsHttpEventCollectorAcl, InputsHttpEventCollectorAclArgs

    App 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 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 write permissions of the resource.
    App 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 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 write permissions of the resource.
    app 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 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 write permissions of the resource.
    app 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 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 write permissions of the resource.
    app 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 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 write permissions of the resource.
    app 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 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 write permissions of the resource.

    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.6 published on Thursday, Mar 21, 2024 by Pulumi