@pulumi/ns1/dataFeed.d.ts

A Pulumi package for creating and managing ns1 cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a NS1 Data Feed resource. This can be used to create, modify, and delete data feeds.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as ns1 from "@pulumi/ns1";
 *
 * const example = new ns1.DataSource("example", {
 *     name: "example",
 *     sourcetype: "nsone_v1",
 * });
 * const exampleMonitoring = new ns1.DataSource("example_monitoring", {
 *     name: "example_monitoring",
 *     sourcetype: "nsone_monitoring",
 * });
 * const uswestFeed = new ns1.DataFeed("uswest_feed", {
 *     name: "uswest_feed",
 *     sourceId: example.id,
 *     config: {
 *         label: "uswest",
 *     },
 * });
 * const useastFeed = new ns1.DataFeed("useast_feed", {
 *     name: "useast_feed",
 *     sourceId: example.id,
 *     config: {
 *         label: "useast",
 *     },
 * });
 * const useastMonitorFeed = new ns1.DataFeed("useast_monitor_feed", {
 *     name: "useast_monitor_feed",
 *     sourceId: exampleMonitoring.id,
 *     config: {
 *         jobid: exampleJob.id,
 *     },
 * });
 * ```
 *
 * ## NS1 Documentation
 *
 * [Datafeed Api Doc](https://ns1.com/api#data-feeds)
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import ns1:index/dataFeed:DataFeed <name> <datasource_id>/<datafeed_id>`
 * ```
 */
export declare class DataFeed extends pulumi.CustomResource {
    /**
     * Get an existing DataFeed 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?: DataFeedState, opts?: pulumi.CustomResourceOptions): DataFeed;
    /**
     * Returns true if the given object is an instance of DataFeed.  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 DataFeed;
    /**
     * The feeds configuration matching the specification in
     * `feedConfig` from /data/sourcetypes. `jobid` is required in the `config` for datafeeds connected to NS1 monitoring.
     */
    readonly config: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The free form name of the data feed.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The data source id that this feed is connected to.
     */
    readonly sourceId: pulumi.Output<string>;
    /**
     * Create a DataFeed 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: DataFeedArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DataFeed resources.
 */
export interface DataFeedState {
    /**
     * The feeds configuration matching the specification in
     * `feedConfig` from /data/sourcetypes. `jobid` is required in the `config` for datafeeds connected to NS1 monitoring.
     */
    config?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The free form name of the data feed.
     */
    name?: pulumi.Input<string>;
    /**
     * The data source id that this feed is connected to.
     */
    sourceId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DataFeed resource.
 */
export interface DataFeedArgs {
    /**
     * The feeds configuration matching the specification in
     * `feedConfig` from /data/sourcetypes. `jobid` is required in the `config` for datafeeds connected to NS1 monitoring.
     */
    config?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The free form name of the data feed.
     */
    name?: pulumi.Input<string>;
    /**
     * The data source id that this feed is connected to.
     */
    sourceId: pulumi.Input<string>;
}