sumologic.InstalledCollector
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
[1]https://help.sumologic.com/03Send-Data/Installed-Collectors/01About-Installed-Collectors [2]https://en.wikipedia.org/wiki/Tz_database [3]https://help.sumologic.com/Manage/Fields [4]https://www.terraform.io/docs/configuration/resources.html#prevent_destroy [5]:https://help.sumologic.com/03Send-Data/Installed-Collectors/05Reference-Information-for-Collector-Installation/11Set-a-Collector-as-Ephemeral
Example Usage
using System.Collections.Generic;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;
return await Deployment.RunAsync(() =>
{
var installedCollector = new SumoLogic.InstalledCollector("installedCollector", new()
{
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, "installedCollector", &sumologic.InstalledCollectorArgs{
Category: pulumi.String("macos/test"),
Ephemeral: pulumi.Bool(true),
Fields: pulumi.StringMap{
"key": pulumi.String("value"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
.category("macos/test")
.ephemeral(true)
.fields(Map.of("key", "value"))
.build());
}
}
import pulumi
import pulumi_sumologic as sumologic
installed_collector = sumologic.InstalledCollector("installedCollector",
category="macos/test",
ephemeral=True,
fields={
"key": "value",
})
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";
const installedCollector = new sumologic.InstalledCollector("installedCollector", {
category: "macos/test",
ephemeral: true,
fields: {
key: "value",
},
});
resources:
installedCollector:
type: sumologic:InstalledCollector
properties:
category: macos/test
ephemeral: true
fields:
key: value
Create InstalledCollector Resource
new InstalledCollector(name: string, args: InstalledCollectorArgs, opts?: CustomResourceOptions);
@overload
def InstalledCollector(resource_name: str,
opts: Optional[ResourceOptions] = None,
category: 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,
name: Optional[str] = None,
source_sync_mode: Optional[str] = None,
target_cpu: Optional[int] = None,
timezone: Optional[str] = None)
@overload
def InstalledCollector(resource_name: str,
args: InstalledCollectorArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
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.
- Cutoff
Timestamp int - Description string
The description of the collector.
- Fields Dictionary<string, string>
Map containing [key/value pairs][3].
- Host
Name 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.
- Source
Sync stringMode 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 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.
- Cutoff
Timestamp int - Description string
The description of the collector.
- Fields map[string]string
Map containing [key/value pairs][3].
- Host
Name 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.
- Source
Sync stringMode 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 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.
- cutoff
Timestamp Integer - description String
The description of the collector.
- fields Map<String,String>
Map containing [key/value pairs][3].
- host
Name 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.
- source
Sync StringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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.
- cutoff
Timestamp number - description string
The description of the collector.
- fields {[key: string]: string}
Map containing [key/value pairs][3].
- host
Name 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.
- source
Sync stringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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_ strmode 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.
- cutoff
Timestamp Number - description String
The description of the collector.
- fields Map<String>
Map containing [key/value pairs][3].
- host
Name 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.
- source
Sync StringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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
- Collector
Version string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Seen intAlive
- Alive bool
- Collector
Version string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Seen intAlive
- alive Boolean
- collector
Version String - id String
The provider-assigned unique ID for this managed resource.
- last
Seen IntegerAlive
- alive boolean
- collector
Version string - id string
The provider-assigned unique ID for this managed resource.
- last
Seen numberAlive
- alive bool
- collector_
version str - id str
The provider-assigned unique ID for this managed resource.
- last_
seen_ intalive
- alive Boolean
- collector
Version String - id String
The provider-assigned unique ID for this managed resource.
- last
Seen NumberAlive
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.
- Alive bool
- Category string
The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
- Collector
Version string - Cutoff
Timestamp 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].
- Host
Name string Host name of the Collector. The hostname can be a maximum of 128 characters.
- Last
Seen intAlive - Name string
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- Source
Sync stringMode 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 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.
- Collector
Version string - Cutoff
Timestamp 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].
- Host
Name string Host name of the Collector. The hostname can be a maximum of 128 characters.
- Last
Seen intAlive - Name string
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- Source
Sync stringMode 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 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.
- collector
Version String - cutoff
Timestamp 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].
- host
Name String Host name of the Collector. The hostname can be a maximum of 128 characters.
- last
Seen IntegerAlive - name String
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- source
Sync StringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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.
- collector
Version string - cutoff
Timestamp 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].
- host
Name string Host name of the Collector. The hostname can be a maximum of 128 characters.
- last
Seen numberAlive - name string
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- source
Sync stringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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_ intalive - name str
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- source_
sync_ strmode 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.
- collector
Version String - cutoff
Timestamp 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].
- host
Name String Host name of the Collector. The hostname can be a maximum of 128 characters.
- last
Seen NumberAlive - name String
The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
- source
Sync StringMode For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
- target
Cpu 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.
Package Details
- Repository
- Sumo Logic pulumi/pulumi-sumologic
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
sumologic
Terraform Provider.