@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
255 lines (254 loc) • 9.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a Sumo Logic CSE [Chain Rule](https://help.sumologic.com/Cloud_SIEM_Enterprise/CSE_Rules/07_Write_a_Chain_Rule).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const chainRule = new sumologic.CseChainRule("chain_rule", {
* description: "Signal description",
* enabled: true,
* entitySelectors: [{
* entityType: "_username",
* expression: "user_username",
* }],
* expressionsAndLimits: [
* {
* expression: "success = false",
* limit: 5,
* },
* {
* expression: "success = true",
* limit: 1,
* },
* ],
* groupByFields: [],
* isPrototype: false,
* ordered: true,
* name: "Chain Rule Example",
* severity: 5,
* summaryExpression: "Signal summary",
* tags: ["_mitreAttackTactic:TA0009"],
* windowSize: "T30M",
* suppressionWindowSize: 2100000,
* });
* ```
*
* ## Import
*
* Chain Rules can be imported using the field id, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/cseChainRule:CseChainRule chain_rule id
* ```
*/
export declare class CseChainRule extends pulumi.CustomResource {
/**
* Get an existing CseChainRule 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?: CseChainRuleState, opts?: pulumi.CustomResourceOptions): CseChainRule;
/**
* Returns true if the given object is an instance of CseChainRule. 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 CseChainRule;
/**
* 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.CseChainRuleEntitySelector[]>;
/**
* The list of expressions and associated limits to make up the conditions of the chain rule
*/
readonly expressionsAndLimits: pulumi.Output<outputs.CseChainRuleExpressionsAndLimit[]>;
/**
* 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 name of the Rule and the generated SignalS
*/
readonly name: pulumi.Output<string>;
/**
* Whether the records matching the expressions must be in the same chronological order as the expressions are listed in the rule
*/
readonly ordered: pulumi.Output<boolean | undefined>;
/**
* 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 CseChainRule 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: CseChainRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CseChainRule resources.
*/
export interface CseChainRuleState {
/**
* 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.CseChainRuleEntitySelector>[]>;
/**
* The list of expressions and associated limits to make up the conditions of the chain rule
*/
expressionsAndLimits?: pulumi.Input<pulumi.Input<inputs.CseChainRuleExpressionsAndLimit>[]>;
/**
* 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 name of the Rule and the generated SignalS
*/
name?: pulumi.Input<string>;
/**
* Whether the records matching the expressions must be in the same chronological order as the expressions are listed in the rule
*/
ordered?: pulumi.Input<boolean>;
/**
* 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 CseChainRule resource.
*/
export interface CseChainRuleArgs {
/**
* 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.CseChainRuleEntitySelector>[]>;
/**
* The list of expressions and associated limits to make up the conditions of the chain rule
*/
expressionsAndLimits: pulumi.Input<pulumi.Input<inputs.CseChainRuleExpressionsAndLimit>[]>;
/**
* 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 name of the Rule and the generated SignalS
*/
name?: pulumi.Input<string>;
/**
* Whether the records matching the expressions must be in the same chronological order as the expressions are listed in the rule
*/
ordered?: pulumi.Input<boolean>;
/**
* 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>;
}