@pulumi/sumologic/fieldExtractionRule.d.ts

A Pulumi package for creating and managing sumologic cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a [Sumologic Field Extraction Rule](https://help.sumologic.com/Manage/Field-Extractions).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const fieldExtractionRule = new sumologic.FieldExtractionRule("fieldExtractionRule", {
 *     name: "exampleFieldExtractionRule",
 *     scope: "_sourceHost=127.0.0.1",
 *     parseExpression: "csv _raw extract 1 as f1",
 *     enabled: true,
 * });
 * ```
 *
 * ## Attributes reference
 *
 * The following attributes are exported:
 *
 * - `id` - Unique identifier for the field extraction rule.
 *
 * ## Import
 *
 * Extraction Rules can be imported using the extraction rule id, e.g.:
 *
 * hcl
 *
 * ```sh
 * $ pulumi import sumologic:index/fieldExtractionRule:FieldExtractionRule fieldExtractionRule id
 * ```
 *
 * [1]: https://help.sumologic.com/Manage/Field-Extractions
 */
export declare class FieldExtractionRule extends pulumi.CustomResource {
    /**
     * Get an existing FieldExtractionRule 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?: FieldExtractionRuleState, opts?: pulumi.CustomResourceOptions): FieldExtractionRule;
    /**
     * Returns true if the given object is an instance of FieldExtractionRule.  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 FieldExtractionRule;
    /**
     * Is the field extraction rule enabled.
     */
    readonly enabled: pulumi.Output<boolean>;
    /**
     * Name of the field extraction rule. Use a name that makes it easy to identify the rule.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Describes the fields to be parsed.
     */
    readonly parseExpression: pulumi.Output<string>;
    /**
     * Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.
     */
    readonly scope: pulumi.Output<string>;
    /**
     * Create a FieldExtractionRule 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: FieldExtractionRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FieldExtractionRule resources.
 */
export interface FieldExtractionRuleState {
    /**
     * Is the field extraction rule enabled.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * Name of the field extraction rule. Use a name that makes it easy to identify the rule.
     */
    name?: pulumi.Input<string>;
    /**
     * Describes the fields to be parsed.
     */
    parseExpression?: pulumi.Input<string>;
    /**
     * Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.
     */
    scope?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FieldExtractionRule resource.
 */
export interface FieldExtractionRuleArgs {
    /**
     * Is the field extraction rule enabled.
     */
    enabled: pulumi.Input<boolean>;
    /**
     * Name of the field extraction rule. Use a name that makes it easy to identify the rule.
     */
    name?: pulumi.Input<string>;
    /**
     * Describes the fields to be parsed.
     */
    parseExpression: pulumi.Input<string>;
    /**
     * Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.
     */
    scope: pulumi.Input<string>;
}