@pulumi/sumologic/collector.d.ts

A Pulumi package for creating and managing sumologic cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a [Sumologic (Hosted) Collector][1].
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const collector = new sumologic.Collector("collector", {
 *     name: "my-collector",
 *     description: "Just testing this",
 *     fields: {
 *         environment: "production",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Collectors can be imported using the collector id, e.g.:
 *
 * hcl
 *
 * ```sh
 * $ pulumi import sumologic:index/collector:Collector 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/collector:Collector test my_test_collector
 * ```
 *
 * [1]: https://help.sumologic.com/docs/send-data/hosted-collectors/
 *
 * [2]: https://en.wikipedia.org/wiki/Tz_database
 *
 * [3]: https://help.sumologic.com/Manage/Fields
 */
export declare class Collector extends pulumi.CustomResource {
    /**
     * Get an existing Collector 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?: CollectorState, opts?: pulumi.CustomResourceOptions): Collector;
    /**
     * Returns true if the given object is an instance of Collector.  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 Collector;
    /**
     * 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>;
    /**
     * The description of the collector.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Map containing [key/value pairs][3].
     */
    readonly fields: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * 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>;
    /**
     * 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 Collector 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?: CollectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Collector resources.
 */
export interface CollectorState {
    /**
     * The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
     */
    category?: pulumi.Input<string>;
    /**
     * The description of the collector.
     */
    description?: pulumi.Input<string>;
    /**
     * Map containing [key/value pairs][3].
     */
    fields?: pulumi.Input<{
        [key: string]: 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>;
    /**
     * 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 Collector resource.
 */
export interface CollectorArgs {
    /**
     * The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
     */
    category?: pulumi.Input<string>;
    /**
     * The description of the collector.
     */
    description?: pulumi.Input<string>;
    /**
     * Map containing [key/value pairs][3].
     */
    fields?: pulumi.Input<{
        [key: string]: 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>;
    /**
     * 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>;
}