1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. SplunkConnector
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

harness.platform.SplunkConnector

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

    Resource for creating a Splunk connector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const test = new harness.platform.SplunkConnector("test", {
        identifier: "identifier",
        name: "name",
        description: "test",
        tags: ["foo:bar"],
        url: "https://splunk.com/",
        delegateSelectors: ["harness-delegate"],
        accountId: "splunk_account_id",
        username: "username",
        passwordRef: "account.secret_id",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    test = harness.platform.SplunkConnector("test",
        identifier="identifier",
        name="name",
        description="test",
        tags=["foo:bar"],
        url="https://splunk.com/",
        delegate_selectors=["harness-delegate"],
        account_id="splunk_account_id",
        username="username",
        password_ref="account.secret_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewSplunkConnector(ctx, "test", &platform.SplunkConnectorArgs{
    			Identifier:  pulumi.String("identifier"),
    			Name:        pulumi.String("name"),
    			Description: pulumi.String("test"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    			Url: pulumi.String("https://splunk.com/"),
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("harness-delegate"),
    			},
    			AccountId:   pulumi.String("splunk_account_id"),
    			Username:    pulumi.String("username"),
    			PasswordRef: pulumi.String("account.secret_id"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Harness.Platform.SplunkConnector("test", new()
        {
            Identifier = "identifier",
            Name = "name",
            Description = "test",
            Tags = new[]
            {
                "foo:bar",
            },
            Url = "https://splunk.com/",
            DelegateSelectors = new[]
            {
                "harness-delegate",
            },
            AccountId = "splunk_account_id",
            Username = "username",
            PasswordRef = "account.secret_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.SplunkConnector;
    import com.pulumi.harness.platform.SplunkConnectorArgs;
    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 test = new SplunkConnector("test", SplunkConnectorArgs.builder()
                .identifier("identifier")
                .name("name")
                .description("test")
                .tags("foo:bar")
                .url("https://splunk.com/")
                .delegateSelectors("harness-delegate")
                .accountId("splunk_account_id")
                .username("username")
                .passwordRef("account.secret_id")
                .build());
    
        }
    }
    
    resources:
      test:
        type: harness:platform:SplunkConnector
        properties:
          identifier: identifier
          name: name
          description: test
          tags:
            - foo:bar
          url: https://splunk.com/
          delegateSelectors:
            - harness-delegate
          accountId: splunk_account_id
          username: username
          passwordRef: account.secret_id
    

    Create SplunkConnector Resource

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

    Constructor syntax

    new SplunkConnector(name: string, args: SplunkConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def SplunkConnector(resource_name: str,
                        args: SplunkConnectorArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SplunkConnector(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        account_id: Optional[str] = None,
                        identifier: Optional[str] = None,
                        password_ref: Optional[str] = None,
                        url: Optional[str] = None,
                        username: Optional[str] = None,
                        delegate_selectors: Optional[Sequence[str]] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        org_id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None)
    func NewSplunkConnector(ctx *Context, name string, args SplunkConnectorArgs, opts ...ResourceOption) (*SplunkConnector, error)
    public SplunkConnector(string name, SplunkConnectorArgs args, CustomResourceOptions? opts = null)
    public SplunkConnector(String name, SplunkConnectorArgs args)
    public SplunkConnector(String name, SplunkConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:SplunkConnector
    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 SplunkConnectorArgs
    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 SplunkConnectorArgs
    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 SplunkConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SplunkConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SplunkConnectorArgs
    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 splunkConnectorResource = new Harness.Platform.SplunkConnector("splunkConnectorResource", new()
    {
        AccountId = "string",
        Identifier = "string",
        PasswordRef = "string",
        Url = "string",
        Username = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewSplunkConnector(ctx, "splunkConnectorResource", &platform.SplunkConnectorArgs{
    	AccountId:   pulumi.String("string"),
    	Identifier:  pulumi.String("string"),
    	PasswordRef: pulumi.String("string"),
    	Url:         pulumi.String("string"),
    	Username:    pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var splunkConnectorResource = new SplunkConnector("splunkConnectorResource", SplunkConnectorArgs.builder()
        .accountId("string")
        .identifier("string")
        .passwordRef("string")
        .url("string")
        .username("string")
        .delegateSelectors("string")
        .description("string")
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    splunk_connector_resource = harness.platform.SplunkConnector("splunkConnectorResource",
        account_id="string",
        identifier="string",
        password_ref="string",
        url="string",
        username="string",
        delegate_selectors=["string"],
        description="string",
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const splunkConnectorResource = new harness.platform.SplunkConnector("splunkConnectorResource", {
        accountId: "string",
        identifier: "string",
        passwordRef: "string",
        url: "string",
        username: "string",
        delegateSelectors: ["string"],
        description: "string",
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:SplunkConnector
    properties:
        accountId: string
        delegateSelectors:
            - string
        description: string
        identifier: string
        name: string
        orgId: string
        passwordRef: string
        projectId: string
        tags:
            - string
        url: string
        username: string
    

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

    AccountId string
    Splunk account id.
    Identifier string
    Unique identifier of the resource.
    PasswordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Url string
    URL of the Splunk server.
    Username string
    The username used for connecting to Splunk.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    AccountId string
    Splunk account id.
    Identifier string
    Unique identifier of the resource.
    PasswordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Url string
    URL of the Splunk server.
    Username string
    The username used for connecting to Splunk.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    accountId String
    Splunk account id.
    identifier String
    Unique identifier of the resource.
    passwordRef String
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    url String
    URL of the Splunk server.
    username String
    The username used for connecting to Splunk.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    accountId string
    Splunk account id.
    identifier string
    Unique identifier of the resource.
    passwordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    url string
    URL of the Splunk server.
    username string
    The username used for connecting to Splunk.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    account_id str
    Splunk account id.
    identifier str
    Unique identifier of the resource.
    password_ref str
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    url str
    URL of the Splunk server.
    username str
    The username used for connecting to Splunk.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    accountId String
    Splunk account id.
    identifier String
    Unique identifier of the resource.
    passwordRef String
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    url String
    URL of the Splunk server.
    username String
    The username used for connecting to Splunk.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Get an existing SplunkConnector 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?: SplunkConnectorState, opts?: CustomResourceOptions): SplunkConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            password_ref: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            url: Optional[str] = None,
            username: Optional[str] = None) -> SplunkConnector
    func GetSplunkConnector(ctx *Context, name string, id IDInput, state *SplunkConnectorState, opts ...ResourceOption) (*SplunkConnector, error)
    public static SplunkConnector Get(string name, Input<string> id, SplunkConnectorState? state, CustomResourceOptions? opts = null)
    public static SplunkConnector get(String name, Output<String> id, SplunkConnectorState 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:
    AccountId string
    Splunk account id.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    PasswordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    URL of the Splunk server.
    Username string
    The username used for connecting to Splunk.
    AccountId string
    Splunk account id.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    PasswordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    Url string
    URL of the Splunk server.
    Username string
    The username used for connecting to Splunk.
    accountId String
    Splunk account id.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    passwordRef String
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the Splunk server.
    username String
    The username used for connecting to Splunk.
    accountId string
    Splunk account id.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    passwordRef string
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    url string
    URL of the Splunk server.
    username string
    The username used for connecting to Splunk.
    account_id str
    Splunk account id.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    password_ref str
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    URL of the Splunk server.
    username str
    The username used for connecting to Splunk.
    accountId String
    Splunk account id.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    passwordRef String
    The reference to the Harness secret containing the Splunk password. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the Splunk server.
    username String
    The username used for connecting to Splunk.

    Import

    Import account level splunk connector

    $ pulumi import harness:platform/splunkConnector:SplunkConnector example <connector_id>
    

    Import org level splunk connector

    $ pulumi import harness:platform/splunkConnector:SplunkConnector example <ord_id>/<connector_id>
    

    Import project level splunk connector

    $ pulumi import harness:platform/splunkConnector:SplunkConnector example <org_id>/<project_id>/<connector_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi