Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splunk Provider
  3. API Docs
  4. AppsLocal
Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-splunk

splunk.AppsLocal

Explore with Pulumi AI

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

    # Resource: splunk.AppsLocal

    Create, install and manage apps on your Splunk instance

    Example Usage

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

const amazonConnectApp = new splunk.AppsLocal("amazon_connect_app", {
    filename: true,
    name: "/usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz",
    explicitAppname: "amazon_connect_app_for_splunk",
});

    import pulumi
import pulumi_splunk as splunk

amazon_connect_app = splunk.AppsLocal("amazon_connect_app",
    filename=True,
    name="/usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz",
    explicit_appname="amazon_connect_app_for_splunk")

    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.NewAppsLocal(ctx, "amazon_connect_app", &splunk.AppsLocalArgs{
			Filename:        pulumi.Bool(true),
			Name:            pulumi.String("/usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz"),
			ExplicitAppname: pulumi.String("amazon_connect_app_for_splunk"),
		})
		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 amazonConnectApp = new Splunk.AppsLocal("amazon_connect_app", new()
    {
        Filename = true,
        Name = "/usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz",
        ExplicitAppname = "amazon_connect_app_for_splunk",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.splunk.AppsLocal;
import com.pulumi.splunk.AppsLocalArgs;
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 amazonConnectApp = new AppsLocal("amazonConnectApp", AppsLocalArgs.builder()
            .filename(true)
            .name("/usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz")
            .explicitAppname("amazon_connect_app_for_splunk")
            .build());

    }
}

    resources:
  amazonConnectApp:
    type: splunk:AppsLocal
    name: amazon_connect_app
    properties:
      filename: true
      name: /usr/home/amazon_connect_app_for_splunk-0.0.1.tar.gz
      explicitAppname: amazon_connect_app_for_splunk

    Create AppsLocal Resource

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

    Constructor syntax

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

@overload
def AppsLocal(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              acl: Optional[AppsLocalAclArgs] = None,
              auth: Optional[str] = None,
              author: Optional[str] = None,
              configured: Optional[bool] = None,
              description: Optional[str] = None,
              explicit_appname: Optional[str] = None,
              filename: Optional[bool] = None,
              label: Optional[str] = None,
              name: Optional[str] = None,
              session: Optional[str] = None,
              update: Optional[bool] = None,
              version: Optional[str] = None,
              visible: Optional[bool] = None)
    func NewAppsLocal(ctx *Context, name string, args *AppsLocalArgs, opts ...ResourceOption) (*AppsLocal, error)
    public AppsLocal(string name, AppsLocalArgs? args = null, CustomResourceOptions? opts = null)
    public AppsLocal(String name, AppsLocalArgs args)
public AppsLocal(String name, AppsLocalArgs args, CustomResourceOptions options)

    type: splunk:AppsLocal
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 AppsLocalArgs
    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 AppsLocalArgs
    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 AppsLocalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppsLocalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppsLocalArgs
    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 appsLocalResource = new Splunk.AppsLocal("appsLocalResource", new()
{
    Acl = new Splunk.Inputs.AppsLocalAclArgs
    {
        App = "string",
        CanChangePerms = false,
        CanShareApp = false,
        CanShareGlobal = false,
        CanShareUser = false,
        CanWrite = false,
        Owner = "string",
        Reads = new[]
        {
            "string",
        },
        Removable = false,
        Sharing = "string",
        Writes = new[]
        {
            "string",
        },
    },
    Auth = "string",
    Author = "string",
    Configured = false,
    Description = "string",
    ExplicitAppname = "string",
    Filename = false,
    Label = "string",
    Name = "string",
    Session = "string",
    Update = false,
    Version = "string",
    Visible = false,
});

    example, err := splunk.NewAppsLocal(ctx, "appsLocalResource", &splunk.AppsLocalArgs{
	Acl: &splunk.AppsLocalAclArgs{
		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"),
		},
	},
	Auth:            pulumi.String("string"),
	Author:          pulumi.String("string"),
	Configured:      pulumi.Bool(false),
	Description:     pulumi.String("string"),
	ExplicitAppname: pulumi.String("string"),
	Filename:        pulumi.Bool(false),
	Label:           pulumi.String("string"),
	Name:            pulumi.String("string"),
	Session:         pulumi.String("string"),
	Update:          pulumi.Bool(false),
	Version:         pulumi.String("string"),
	Visible:         pulumi.Bool(false),
})

    var appsLocalResource = new AppsLocal("appsLocalResource", AppsLocalArgs.builder()
    .acl(AppsLocalAclArgs.builder()
        .app("string")
        .canChangePerms(false)
        .canShareApp(false)
        .canShareGlobal(false)
        .canShareUser(false)
        .canWrite(false)
        .owner("string")
        .reads("string")
        .removable(false)
        .sharing("string")
        .writes("string")
        .build())
    .auth("string")
    .author("string")
    .configured(false)
    .description("string")
    .explicitAppname("string")
    .filename(false)
    .label("string")
    .name("string")
    .session("string")
    .update(false)
    .version("string")
    .visible(false)
    .build());

    apps_local_resource = splunk.AppsLocal("appsLocalResource",
    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"],
    },
    auth="string",
    author="string",
    configured=False,
    description="string",
    explicit_appname="string",
    filename=False,
    label="string",
    name="string",
    session="string",
    update=False,
    version="string",
    visible=False)

    const appsLocalResource = new splunk.AppsLocal("appsLocalResource", {
    acl: {
        app: "string",
        canChangePerms: false,
        canShareApp: false,
        canShareGlobal: false,
        canShareUser: false,
        canWrite: false,
        owner: "string",
        reads: ["string"],
        removable: false,
        sharing: "string",
        writes: ["string"],
    },
    auth: "string",
    author: "string",
    configured: false,
    description: "string",
    explicitAppname: "string",
    filename: false,
    label: "string",
    name: "string",
    session: "string",
    update: false,
    version: "string",
    visible: false,
});

    type: splunk:AppsLocal
properties:
    acl:
        app: string
        canChangePerms: false
        canShareApp: false
        canShareGlobal: false
        canShareUser: false
        canWrite: false
        owner: string
        reads:
            - string
        removable: false
        sharing: string
        writes:
            - string
    auth: string
    author: string
    configured: false
    description: string
    explicitAppname: string
    filename: false
    label: string
    name: string
    session: string
    update: false
    version: string
    visible: false

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

    Acl AppsLocalAcl
    The app/user context that is the namespace for the resource
    Auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    Author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    Configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    Description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    ExplicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    Filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    Label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    Name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    Session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    Update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    Version string
    App version.
    Visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    Acl AppsLocalAclArgs
    The app/user context that is the namespace for the resource
    Auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    Author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    Configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    Description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    ExplicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    Filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    Label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    Name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    Session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    Update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    Version string
    App version.
    Visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAcl
    The app/user context that is the namespace for the resource
    auth String
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author String
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured Boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description String
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname String
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename Boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label String
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name String
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session String
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update Boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version String
    App version.
    visible Boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAcl
    The app/user context that is the namespace for the resource
    auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version string
    App version.
    visible boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAclArgs
    The app/user context that is the namespace for the resource
    auth str
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author str
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description str
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicit_appname str
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label str
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name str
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session str
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version str
    App version.
    visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl Property Map
    The app/user context that is the namespace for the resource
    auth String
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author String
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured Boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description String
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname String
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename Boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label String
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name String
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session String
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update Boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version String
    App version.
    visible Boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.

    Outputs

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

    Get an existing AppsLocal 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?: AppsLocalState, opts?: CustomResourceOptions): AppsLocal
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[AppsLocalAclArgs] = None,
        auth: Optional[str] = None,
        author: Optional[str] = None,
        configured: Optional[bool] = None,
        description: Optional[str] = None,
        explicit_appname: Optional[str] = None,
        filename: Optional[bool] = None,
        label: Optional[str] = None,
        name: Optional[str] = None,
        session: Optional[str] = None,
        update: Optional[bool] = None,
        version: Optional[str] = None,
        visible: Optional[bool] = None) -> AppsLocal
    func GetAppsLocal(ctx *Context, name string, id IDInput, state *AppsLocalState, opts ...ResourceOption) (*AppsLocal, error)
    public static AppsLocal Get(string name, Input<string> id, AppsLocalState? state, CustomResourceOptions? opts = null)
    public static AppsLocal get(String name, Output<String> id, AppsLocalState 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 AppsLocalAcl
    The app/user context that is the namespace for the resource
    Auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    Author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    Configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    Description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    ExplicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    Filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    Label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    Name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    Session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    Update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    Version string
    App version.
    Visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    Acl AppsLocalAclArgs
    The app/user context that is the namespace for the resource
    Auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    Author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    Configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    Description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    ExplicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    Filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    Label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    Name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    Session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    Update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    Version string
    App version.
    Visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAcl
    The app/user context that is the namespace for the resource
    auth String
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author String
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured Boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description String
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname String
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename Boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label String
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name String
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session String
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update Boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version String
    App version.
    visible Boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAcl
    The app/user context that is the namespace for the resource
    auth string
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author string
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description string
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname string
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label string
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name string
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session string
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version string
    App version.
    visible boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl AppsLocalAclArgs
    The app/user context that is the namespace for the resource
    auth str
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author str
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured bool
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description str
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicit_appname str
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename bool
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label str
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name str
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session str
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update bool
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version str
    App version.
    visible bool
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.
    acl Property Map
    The app/user context that is the namespace for the resource
    auth String
    Splunkbase session token for operations like install and update that require login. Use auth or session when installing or updating an app through Splunkbase.
    author String
    For apps posted to Splunkbase, use your Splunk account username. For internal apps, include your name and contact information.
    configured Boolean
    Custom setup complete indication: true = Custom app setup complete. false = Custom app setup not complete.
    description String
    Short app description also displayed below the app title in Splunk Web Launcher.
    explicitAppname String
    Custom app name. Overrides name when installing an app from a file where filename is set to true. See also filename.
    filename Boolean
    Indicates whether to use the name value as the app source location. true indicates that name is a path to a file to install. false indicates that name is the literal app name and that the app is created from Splunkbase using a template.
    label String
    App name displayed in Splunk Web, from five to eighty characters excluding the prefix "Splunk for".
    name String
    Literal app name or path for the file to install, depending on the value of filename. filename = false indicates that name is the literal app name and that the app is created from Splunkbase using a template. filename = true indicates that name is the URL or path to the local .tar, .tgz or .spl file. If name is the Splunkbase URL, set auth or session to authenticate the request. The app folder name cannot include spaces or special characters.
    session String
    Login session token for installing or updating an app on Splunkbase. Alternatively, use auth.
    update Boolean
    File-based update indication: true specifies that filename should be used to update an existing app. If not specified, update defaults to false, which indicates that filename should not be used to update an existing app.
    version String
    App version.
    visible Boolean
    Indicates whether the app is visible and navigable from Splunk Web. true = App is visible and navigable. false = App is not visible or navigable.

    Supporting Types

    AppsLocalAcl, AppsLocalAclArgs

    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 resource write permissions.
    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 resource write permissions.
    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 resource write permissions.
    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 resource write permissions.
    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 resource write permissions.
    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 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 logo
    Splunk v1.2.14 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-splunk