@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
205 lines (204 loc) • 8.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* 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
*
* Collectors can be imported using the collector id, e.g.:
*
* hcl
*
* ```sh
* $ 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
*
* ```sh
* $ 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
*/
export declare class InstalledCollector extends pulumi.CustomResource {
/**
* Get an existing InstalledCollector resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstalledCollectorState, opts?: pulumi.CustomResourceOptions): InstalledCollector;
/**
* Returns true if the given object is an instance of InstalledCollector. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is InstalledCollector;
readonly alive: pulumi.Output<boolean>;
/**
* The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
*/
readonly category: pulumi.Output<string | undefined>;
readonly collectorVersion: pulumi.Output<string>;
readonly cutoffTimestamp: pulumi.Output<number | undefined>;
/**
* The description of the collector.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
*/
readonly ephemeral: pulumi.Output<boolean>;
/**
* Map containing [key/value pairs][3].
*/
readonly fields: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Host name of the Collector. The hostname can be a maximum of 128 characters.
*/
readonly hostName: pulumi.Output<string | undefined>;
readonly lastSeenAlive: pulumi.Output<number>;
/**
* The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
*/
readonly name: pulumi.Output<string>;
/**
* For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
*/
readonly sourceSyncMode: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly targetCpu: pulumi.Output<number | undefined>;
/**
* The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention.
*/
readonly timezone: pulumi.Output<string | undefined>;
/**
* Create a InstalledCollector resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: InstalledCollectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstalledCollector resources.
*/
export interface InstalledCollectorState {
alive?: pulumi.Input<boolean>;
/**
* The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
*/
category?: pulumi.Input<string>;
collectorVersion?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
/**
* The description of the collector.
*/
description?: pulumi.Input<string>;
/**
* When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
*/
ephemeral?: pulumi.Input<boolean>;
/**
* Map containing [key/value pairs][3].
*/
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Host name of the Collector. The hostname can be a maximum of 128 characters.
*/
hostName?: pulumi.Input<string>;
lastSeenAlive?: pulumi.Input<number>;
/**
* The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
*/
name?: pulumi.Input<string>;
/**
* For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
*/
sourceSyncMode?: pulumi.Input<string>;
/**
* 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.
*/
targetCpu?: pulumi.Input<number>;
/**
* The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention.
*/
timezone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstalledCollector resource.
*/
export interface InstalledCollectorArgs {
/**
* The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
*/
category?: pulumi.Input<string>;
cutoffTimestamp?: pulumi.Input<number>;
/**
* The description of the collector.
*/
description?: pulumi.Input<string>;
/**
* When true, the collector will be deleted after 12 hours of inactivity. For more information, see [Setting a Collector as Ephemeral][5].
*/
ephemeral: pulumi.Input<boolean>;
/**
* Map containing [key/value pairs][3].
*/
fields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Host name of the Collector. The hostname can be a maximum of 128 characters.
*/
hostName?: pulumi.Input<string>;
/**
* The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
*/
name?: pulumi.Input<string>;
/**
* For installed Collectors, whether the Collector is using local source configuration management (using a JSON file), or cloud management (using the UI)
*/
sourceSyncMode?: pulumi.Input<string>;
/**
* 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.
*/
targetCpu?: pulumi.Input<number>;
/**
* The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention.
*/
timezone?: pulumi.Input<string>;
}