Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

AppsLocal

# Resource: splunk.AppsLocal

Create, install and manage apps on your Splunk instance

Example Usage

using Pulumi;
using Splunk = Pulumi.Splunk;

class MyStack : Stack
{
    public MyStack()
    {
        var amazonConnectApp = new Splunk.AppsLocal("amazonConnectApp", new Splunk.AppsLocalArgs
        {
            ExplicitAppname = "amazon_connect_app_for_splunk",
            Filename = true,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-splunk/sdk/go/splunk"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := splunk.NewAppsLocal(ctx, "amazonConnectApp", &splunk.AppsLocalArgs{
            ExplicitAppname: pulumi.String("amazon_connect_app_for_splunk"),
            Filename:        pulumi.Bool(true),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_splunk as splunk

amazon_connect_app = splunk.AppsLocal("amazonConnectApp",
    explicit_appname="amazon_connect_app_for_splunk",
    filename=True)
import * as pulumi from "@pulumi/pulumi";
import * as splunk from "@pulumi/splunk";

const amazonConnectApp = new splunk.AppsLocal("amazon_connect_app", {
    explicitAppname: "amazon_connect_app_for_splunk", // Original app name is required when filename is set to true
    filename: true,
});

Create a AppsLocal Resource

new AppsLocal(name: string, args?: AppsLocalArgs, opts?: CustomResourceOptions);
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)
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.
opts ResourceOptions
A bag of options that control this 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.

AppsLocal Resource Properties

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

Inputs

The AppsLocal resource accepts the following input properties:

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 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 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.

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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)
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.

The following state arguments are supported:

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 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 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.

Supporting Types

AppsLocalAcl

App string
CanChangePerms bool
CanShareApp bool
CanShareGlobal bool
CanShareUser bool
CanWrite bool
Owner string
Reads List<string>
Removable bool
Sharing string
Writes List<string>
App string
CanChangePerms bool
CanShareApp bool
CanShareGlobal bool
CanShareUser bool
CanWrite bool
Owner string
Reads []string
Removable bool
Sharing string
Writes []string
app string
canChangePerms boolean
canShareApp boolean
canShareGlobal boolean
canShareUser boolean
canWrite boolean
owner string
reads string[]
removable boolean
sharing string
writes string[]
app str
can_change_perms bool
can_share_app bool
can_share_global bool
can_share_user bool
can_write bool
owner str
reads Sequence[str]
removable bool
sharing str
writes Sequence[str]

Package Details

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