UNPKG

@pulumi/sumologic

Version:

A Pulumi package for creating and managing sumologic cloud resources.

276 lines (275 loc) 9.09 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * ## layout: "sumologic" * * page_title: "SumoLogic: sumologic.CseOutlierRule" * description: |- * Provides a CSE Outlier Rule * --- * * # sumologic.CseOutlierRule * Provides a Sumo Logic CSE [Outlier Rule](https://help.sumologic.com/docs/cse/rules/write-outlier-rule/). * * ## Import * * Outlier rules can be imported using the field id, e.g.: * * hcl * * ```sh * $ pulumi import sumologic:index/cseOutlierRule:CseOutlierRule outlier_rule id * ``` */ export declare class CseOutlierRule extends pulumi.CustomResource { /** * Get an existing CseOutlierRule 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?: CseOutlierRuleState, opts?: pulumi.CustomResourceOptions): CseOutlierRule; /** * Returns true if the given object is an instance of CseOutlierRule. 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 CseOutlierRule; readonly aggregationFunctions: pulumi.Output<outputs.CseOutlierRuleAggregationFunctions>; /** * The baseline window size in milliseconds */ readonly baselineWindowSize: pulumi.Output<string>; /** * The description of the generated Signals */ readonly descriptionExpression: pulumi.Output<string>; /** * The deviation threshold used to calculate the threshold to trigger signals */ readonly deviationThreshold: pulumi.Output<number>; /** * 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.CseOutlierRuleEntitySelector[]>; /** * The minimum threshold to trigger signals */ readonly floorValue: pulumi.Output<number>; /** * 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>; /** * The expression for which records to match on */ readonly matchExpression: pulumi.Output<string>; /** * The name of the Rule */ readonly name: pulumi.Output<string>; /** * The name of the generated Signals */ readonly nameExpression: pulumi.Output<string>; /** * The retention window size in milliseconds */ readonly retentionWindowSize: 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>; /** * The window size. Current acceptable values are T60M (1 hr) or T24H (1 day) */ readonly windowSize: pulumi.Output<string>; /** * Create a CseOutlierRule 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: CseOutlierRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CseOutlierRule resources. */ export interface CseOutlierRuleState { aggregationFunctions?: pulumi.Input<inputs.CseOutlierRuleAggregationFunctions>; /** * The baseline window size in milliseconds */ baselineWindowSize?: pulumi.Input<string>; /** * The description of the generated Signals */ descriptionExpression?: pulumi.Input<string>; /** * The deviation threshold used to calculate the threshold to trigger signals */ deviationThreshold?: pulumi.Input<number>; /** * 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.CseOutlierRuleEntitySelector>[]>; /** * The minimum threshold to trigger signals */ floorValue?: pulumi.Input<number>; /** * 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>; /** * The expression for which records to match on */ matchExpression?: pulumi.Input<string>; /** * The name of the Rule */ name?: pulumi.Input<string>; /** * The name of the generated Signals */ nameExpression?: pulumi.Input<string>; /** * The retention window size in milliseconds */ retentionWindowSize?: 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>[]>; /** * The window size. Current acceptable values are T60M (1 hr) or T24H (1 day) */ windowSize?: pulumi.Input<string>; } /** * The set of arguments for constructing a CseOutlierRule resource. */ export interface CseOutlierRuleArgs { aggregationFunctions: pulumi.Input<inputs.CseOutlierRuleAggregationFunctions>; /** * The baseline window size in milliseconds */ baselineWindowSize: pulumi.Input<string>; /** * The description of the generated Signals */ descriptionExpression: pulumi.Input<string>; /** * The deviation threshold used to calculate the threshold to trigger signals */ deviationThreshold: pulumi.Input<number>; /** * 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.CseOutlierRuleEntitySelector>[]>; /** * The minimum threshold to trigger signals */ floorValue: pulumi.Input<number>; /** * 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>; /** * The expression for which records to match on */ matchExpression: pulumi.Input<string>; /** * The name of the Rule */ name?: pulumi.Input<string>; /** * The name of the generated Signals */ nameExpression: pulumi.Input<string>; /** * The retention window size in milliseconds */ retentionWindowSize: 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>[]>; /** * The window size. Current acceptable values are T60M (1 hr) or T24H (1 day) */ windowSize: pulumi.Input<string>; }