@pulumi/sumologic

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Provides a Sumo Logic CSE [Threshold Rule](https://help.sumologic.com/Cloud_SIEM_Enterprise/CSE_Rules/05_Write_a_Threshold_Rule). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as sumologic from "@pulumi/sumologic"; * * const thresholdRule = new sumologic.CseThresholdRule("threshold_rule", { * countDistinct: true, * countField: "dstDevice_hostname", * description: "Signal description", * enabled: true, * entitySelectors: [{ * entityType: "_ip", * expression: "srcDevice_ip", * }], * expression: "objectType = \"Network\"", * groupByFields: ["dstDevice_hostname"], * isPrototype: false, * limit: 1000, * name: "Threshold Rule Example", * severity: 5, * summaryExpression: "Signal summary", * tags: ["_mitreAttackTactic:TA0009"], * windowSize: "T30M", * suppressionWindowSize: 2100000, * }); * ``` * * ## Import * * Threshold Rules can be imported using the field id, e.g.: * * hcl * * ```sh * $ pulumi import sumologic:index/cseThresholdRule:CseThresholdRule threshold_rule id * ``` */ export declare class CseThresholdRule extends pulumi.CustomResource { /** * Get an existing CseThresholdRule 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?: CseThresholdRuleState, opts?: pulumi.CustomResourceOptions): CseThresholdRule; /** * Returns true if the given object is an instance of CseThresholdRule. 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 CseThresholdRule; /** * Whether to count distinct values of a field, as opposed to just counting the number of records */ readonly countDistinct: pulumi.Output<boolean | undefined>; /** * The field to count if `countDistinct` is set to true */ readonly countField: pulumi.Output<string | undefined>; /** * The description of the generated Signals */ readonly description: pulumi.Output<string>; /** * Whether the rule should generate Signals */ readonly enabled: pulumi.Output<boolean>; /** * The entities to generate Signals on * + `entityType` - (Required) The type of the entity to generate the Signal on. */ readonly entitySelectors: pulumi.Output<outputs.CseThresholdRuleEntitySelector[]>; /** * The expression for which records to match on */ readonly expression: pulumi.Output<string>; /** * A list of fields to group records by */ readonly groupByFields: pulumi.Output<string[] | undefined>; /** * Whether the generated Signals should be prototype Signals */ readonly isPrototype: pulumi.Output<boolean | undefined>; /** * A Signal will be fired when this many records/distinct field values are matched */ readonly limit: pulumi.Output<number>; /** * The name of the Rule and the generated Signals */ readonly name: pulumi.Output<string>; /** * The severity of the generated Signals */ readonly severity: pulumi.Output<number>; /** * The summary of the generated Signals */ readonly summaryExpression: pulumi.Output<string | undefined>; /** * For how long to suppress Signal generation, in milliseconds. Must be greater than `windowSize` and less than the global limit of 7 days. * * The following attributes are exported: */ readonly suppressionWindowSize: pulumi.Output<number | undefined>; /** * The tags of the generated Signals */ readonly tags: pulumi.Output<string[] | undefined>; /** * How long of a window to aggregate records for. Current acceptable values are T05M, T10M, T30M, T60M, T24H, T12H, T05D or CUSTOM */ readonly windowSize: pulumi.Output<string>; readonly windowSizeMillis: pulumi.Output<string | undefined>; /** * Create a CseThresholdRule 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: CseThresholdRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CseThresholdRule resources. */ export interface CseThresholdRuleState { /** * Whether to count distinct values of a field, as opposed to just counting the number of records */ countDistinct?: pulumi.Input<boolean>; /** * The field to count if `countDistinct` is set to true */ countField?: pulumi.Input<string>; /** * The description of the generated Signals */ description?: pulumi.Input<string>; /** * Whether the rule should generate Signals */ enabled?: pulumi.Input<boolean>; /** * The entities to generate Signals on * + `entityType` - (Required) The type of the entity to generate the Signal on. */ entitySelectors?: pulumi.Input<pulumi.Input<inputs.CseThresholdRuleEntitySelector>[]>; /** * The expression for which records to match on */ expression?: pulumi.Input<string>; /** * A list of fields to group records by */ groupByFields?: pulumi.Input<pulumi.Input<string>[]>; /** * Whether the generated Signals should be prototype Signals */ isPrototype?: pulumi.Input<boolean>; /** * A Signal will be fired when this many records/distinct field values are matched */ limit?: pulumi.Input<number>; /** * The name of the Rule and the generated Signals */ name?: pulumi.Input<string>; /** * The severity of the generated Signals */ severity?: pulumi.Input<number>; /** * The summary of the generated Signals */ summaryExpression?: pulumi.Input<string>; /** * For how long to suppress Signal generation, in milliseconds. Must be greater than `windowSize` and less than the global limit of 7 days. * * The following attributes are exported: */ suppressionWindowSize?: pulumi.Input<number>; /** * The tags of the generated Signals */ tags?: pulumi.Input<pulumi.Input<string>[]>; /** * How long of a window to aggregate records for. Current acceptable values are T05M, T10M, T30M, T60M, T24H, T12H, T05D or CUSTOM */ windowSize?: pulumi.Input<string>; windowSizeMillis?: pulumi.Input<string>; } /** * The set of arguments for constructing a CseThresholdRule resource. */ export interface CseThresholdRuleArgs { /** * Whether to count distinct values of a field, as opposed to just counting the number of records */ countDistinct?: pulumi.Input<boolean>; /** * The field to count if `countDistinct` is set to true */ countField?: pulumi.Input<string>; /** * The description of the generated Signals */ description: pulumi.Input<string>; /** * Whether the rule should generate Signals */ enabled: pulumi.Input<boolean>; /** * The entities to generate Signals on * + `entityType` - (Required) The type of the entity to generate the Signal on. */ entitySelectors: pulumi.Input<pulumi.Input<inputs.CseThresholdRuleEntitySelector>[]>; /** * The expression for which records to match on */ expression: pulumi.Input<string>; /** * A list of fields to group records by */ groupByFields?: pulumi.Input<pulumi.Input<string>[]>; /** * Whether the generated Signals should be prototype Signals */ isPrototype?: pulumi.Input<boolean>; /** * A Signal will be fired when this many records/distinct field values are matched */ limit: pulumi.Input<number>; /** * The name of the Rule and the generated Signals */ name?: pulumi.Input<string>; /** * The severity of the generated Signals */ severity: pulumi.Input<number>; /** * The summary of the generated Signals */ summaryExpression?: pulumi.Input<string>; /** * For how long to suppress Signal generation, in milliseconds. Must be greater than `windowSize` and less than the global limit of 7 days. * * The following attributes are exported: */ suppressionWindowSize?: pulumi.Input<number>; /** * The tags of the generated Signals */ tags?: pulumi.Input<pulumi.Input<string>[]>; /** * How long of a window to aggregate records for. Current acceptable values are T05M, T10M, T30M, T60M, T24H, T12H, T05D or CUSTOM */ windowSize: pulumi.Input<string>; windowSizeMillis?: pulumi.Input<string>; }