Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumologic Provider
  3. API Docs
  4. InstalledCollector
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.InstalledCollector

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

    Example Usage

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

const installedCollector = new sumologic.InstalledCollector("installed_collector", {
    name: "test-mac",
    category: "macos/test",
    ephemeral: true,
    fields: {
        key: "value",
    },
});

    import pulumi
import pulumi_sumologic as sumologic

installed_collector = sumologic.InstalledCollector("installed_collector",
    name="test-mac",
    category="macos/test",
    ephemeral=True,
    fields={
        "key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewInstalledCollector(ctx, "installed_collector", &sumologic.InstalledCollectorArgs{
			Name:      pulumi.String("test-mac"),
			Category:  pulumi.String("macos/test"),
			Ephemeral: pulumi.Bool(true),
			Fields: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var installedCollector = new SumoLogic.InstalledCollector("installed_collector", new()
    {
        Name = "test-mac",
        Category = "macos/test",
        Ephemeral = true,
        Fields = 
        {
            { "key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.InstalledCollector;
import com.pulumi.sumologic.InstalledCollectorArgs;
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 installedCollector = new InstalledCollector("installedCollector", InstalledCollectorArgs.builder()
            .name("test-mac")
            .category("macos/test")
            .ephemeral(true)
            .fields(Map.of("key", "value"))
            .build());

    }
}

    resources:
  installedCollector:
    type: sumologic:InstalledCollector
    name: installed_collector
    properties:
      name: test-mac
      category: macos/test
      ephemeral: true
      fields:
        key: value

    Create InstalledCollector Resource

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

    Constructor syntax

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

@overload
def InstalledCollector(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       ephemeral: Optional[bool] = None,
                       category: Optional[str] = None,
                       cutoff_timestamp: Optional[int] = None,
                       description: Optional[str] = None,
                       fields: Optional[Mapping[str, str]] = None,
                       host_name: Optional[str] = None,
                       name: Optional[str] = None,
                       source_sync_mode: Optional[str] = None,
                       target_cpu: Optional[int] = None,
                       timezone: Optional[str] = None)
    func NewInstalledCollector(ctx *Context, name string, args InstalledCollectorArgs, opts ...ResourceOption) (*InstalledCollector, error)
    public InstalledCollector(string name, InstalledCollectorArgs args, CustomResourceOptions? opts = null)
    public InstalledCollector(String name, InstalledCollectorArgs args)
public InstalledCollector(String name, InstalledCollectorArgs args, CustomResourceOptions options)

    type: sumologic:InstalledCollector
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 InstalledCollectorArgs
    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 InstalledCollectorArgs
    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 InstalledCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstalledCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstalledCollectorArgs
    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 installedCollectorResource = new SumoLogic.InstalledCollector("installedCollectorResource", new()
{
    Ephemeral = false,
    Category = "string",
    CutoffTimestamp = 0,
    Description = "string",
    Fields = 
    {
        { "string", "string" },
    },
    HostName = "string",
    Name = "string",
    SourceSyncMode = "string",
    TargetCpu = 0,
    Timezone = "string",
});

    example, err := sumologic.NewInstalledCollector(ctx, "installedCollectorResource", &sumologic.InstalledCollectorArgs{
	Ephemeral:       pulumi.Bool(false),
	Category:        pulumi.String("string"),
	CutoffTimestamp: pulumi.Int(0),
	Description:     pulumi.String("string"),
	Fields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	HostName:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	SourceSyncMode: pulumi.String("string"),
	TargetCpu:      pulumi.Int(0),
	Timezone:       pulumi.String("string"),
})

    var installedCollectorResource = new InstalledCollector("installedCollectorResource", InstalledCollectorArgs.builder()
    .ephemeral(false)
    .category("string")
    .cutoffTimestamp(0)
    .description("string")
    .fields(Map.of("string", "string"))
    .hostName("string")
    .name("string")
    .sourceSyncMode("string")
    .targetCpu(0)
    .timezone("string")
    .build());

    installed_collector_resource = sumologic.InstalledCollector("installedCollectorResource",
    ephemeral=False,
    category="string",
    cutoff_timestamp=0,
    description="string",
    fields={
        "string": "string",
    },
    host_name="string",
    name="string",
    source_sync_mode="string",
    target_cpu=0,
    timezone="string")

    const installedCollectorResource = new sumologic.InstalledCollector("installedCollectorResource", {
    ephemeral: false,
    category: "string",
    cutoffTimestamp: 0,
    description: "string",
    fields: {
        string: "string",
    },
    hostName: "string",
    name: "string",
    sourceSyncMode: "string",
    targetCpu: 0,
    timezone: "string",
});

    type: sumologic:InstalledCollector
properties:
    category: string
    cutoffTimestamp: 0
    description: string
    ephemeral: false
    fields:
        string: string
    hostName: string
    name: string
    sourceSyncMode: string
    targetCpu: 0
    timezone: string

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

    Ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    Category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    CutoffTimestamp int
    Description string
    The description of the collector.
    Fields Dictionary<string, string>
    Map containing [key/value pairs][3].
    HostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    Name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    SourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    TargetCpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    Ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    Category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    CutoffTimestamp int
    Description string
    The description of the collector.
    Fields map[string]string
    Map containing [key/value pairs][3].
    HostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    Name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    SourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    TargetCpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    ephemeral Boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    category String
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    cutoffTimestamp Integer
    description String
    The description of the collector.
    fields Map<String,String>
    Map containing [key/value pairs][3].
    hostName String
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    name String
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode String
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu Integer
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention.
    ephemeral boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    cutoffTimestamp number
    description string
    The description of the collector.
    fields {[key: string]: string}
    Map containing [key/value pairs][3].
    hostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu number
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    category str
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    cutoff_timestamp int
    description str
    The description of the collector.
    fields Mapping[str, str]
    Map containing [key/value pairs][3].
    host_name str
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    name str
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    source_sync_mode str
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    target_cpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone str
    The time zone to use for this collector. The value follows the tzdata naming convention.
    ephemeral Boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    category String
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    cutoffTimestamp Number
    description String
    The description of the collector.
    fields Map<String>
    Map containing [key/value pairs][3].
    hostName String
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    name String
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode String
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu Number
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InstalledCollector resource produces the following output properties:

    Alive bool
    CollectorVersion string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSeenAlive int
    Alive bool
    CollectorVersion string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSeenAlive int
    alive Boolean
    collectorVersion String
    id String
    The provider-assigned unique ID for this managed resource.
    lastSeenAlive Integer
    alive boolean
    collectorVersion string
    id string
    The provider-assigned unique ID for this managed resource.
    lastSeenAlive number
    alive bool
    collector_version str
    id str
    The provider-assigned unique ID for this managed resource.
    last_seen_alive int
    alive Boolean
    collectorVersion String
    id String
    The provider-assigned unique ID for this managed resource.
    lastSeenAlive Number

    Look up Existing InstalledCollector Resource

    Get an existing InstalledCollector 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?: InstalledCollectorState, opts?: CustomResourceOptions): InstalledCollector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alive: Optional[bool] = None,
        category: Optional[str] = None,
        collector_version: Optional[str] = None,
        cutoff_timestamp: Optional[int] = None,
        description: Optional[str] = None,
        ephemeral: Optional[bool] = None,
        fields: Optional[Mapping[str, str]] = None,
        host_name: Optional[str] = None,
        last_seen_alive: Optional[int] = None,
        name: Optional[str] = None,
        source_sync_mode: Optional[str] = None,
        target_cpu: Optional[int] = None,
        timezone: Optional[str] = None) -> InstalledCollector
    func GetInstalledCollector(ctx *Context, name string, id IDInput, state *InstalledCollectorState, opts ...ResourceOption) (*InstalledCollector, error)
    public static InstalledCollector Get(string name, Input<string> id, InstalledCollectorState? state, CustomResourceOptions? opts = null)
    public static InstalledCollector get(String name, Output<String> id, InstalledCollectorState 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:
    Alive bool
    Category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    CollectorVersion string
    CutoffTimestamp int
    Description string
    The description of the collector.
    Ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    Fields Dictionary<string, string>
    Map containing [key/value pairs][3].
    HostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    LastSeenAlive int
    Name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    SourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    TargetCpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    Alive bool
    Category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    CollectorVersion string
    CutoffTimestamp int
    Description string
    The description of the collector.
    Ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    Fields map[string]string
    Map containing [key/value pairs][3].
    HostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    LastSeenAlive int
    Name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    SourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    TargetCpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    alive Boolean
    category String
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    collectorVersion String
    cutoffTimestamp Integer
    description String
    The description of the collector.
    ephemeral Boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    fields Map<String,String>
    Map containing [key/value pairs][3].
    hostName String
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    lastSeenAlive Integer
    name String
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode String
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu Integer
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention.
    alive boolean
    category string
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    collectorVersion string
    cutoffTimestamp number
    description string
    The description of the collector.
    ephemeral boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    fields {[key: string]: string}
    Map containing [key/value pairs][3].
    hostName string
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    lastSeenAlive number
    name string
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode string
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu number
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention.
    alive bool
    category str
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    collector_version str
    cutoff_timestamp int
    description str
    The description of the collector.
    ephemeral bool
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    fields Mapping[str, str]
    Map containing [key/value pairs][3].
    host_name str
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    last_seen_alive int
    name str
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    source_sync_mode str
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    target_cpu int
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone str
    The time zone to use for this collector. The value follows the tzdata naming convention.
    alive Boolean
    category String
    The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
    collectorVersion String
    cutoffTimestamp Number
    description String
    The description of the collector.
    ephemeral Boolean
    When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
    fields Map<String>
    Map containing [key/value pairs][3].
    hostName String
    Host name of the Collector. The hostname can be a maximum of 128 characters.
    lastSeenAlive Number
    name String
    The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
    sourceSyncMode String
    For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
    targetCpu Number
    When CPU utilization exceeds this threshold, the Collector will slow down its rate of ingestion to lower its CPU utilization. Currently only Local and Remote File Sources are supported.
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention.

    Import

    Collectors can be imported using the collector id, e.g.:

    hcl

    $ pulumi import sumologic:index/installedCollector:InstalledCollector test 1234567890

    Collectors can also be imported using the collector name, which is unique per Sumo Logic account, e.g.:

    hcl

    $ pulumi import sumologic:index/installedCollector:InstalledCollector test my_test_collector

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

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
    pulumi/pulumi-sumologic