@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
220 lines (219 loc) • 7.38 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 [Match Rule](https://help.sumologic.com/Cloud_SIEM_Enterprise/CSE_Rules/03_Write_a_Match_Rule).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const matchRule = new sumologic.CseMatchRule("match_rule", {
* descriptionExpression: "Signal description",
* enabled: true,
* entitySelectors: [{
* entityType: "_ip",
* expression: "srcDevice_ip",
* }],
* expression: "objectType = \"Network\"",
* isPrototype: false,
* name: "Match Rule Example",
* nameExpression: "Signal name",
* severityMapping: {
* type: "constant",
* "default": 5,
* },
* summaryExpression: "Signal summary",
* tags: ["_mitreAttackTactic:TA0009"],
* suppressionWindowSize: 2100000,
* });
* ```
*
* ## Import
*
* Match Rules can be imported using the field id, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/cseMatchRule:CseMatchRule match_rule id
* ```
*/
export declare class CseMatchRule extends pulumi.CustomResource {
/**
* Get an existing CseMatchRule 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?: CseMatchRuleState, opts?: pulumi.CustomResourceOptions): CseMatchRule;
/**
* Returns true if the given object is an instance of CseMatchRule. 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 CseMatchRule;
/**
* The description of the generated Signals
*/
readonly descriptionExpression: 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.CseMatchRuleEntitySelector[]>;
/**
* The expression for which records to match on
*/
readonly expression: pulumi.Output<string>;
/**
* Whether the generated Signals should be prototype Signals
*/
readonly isPrototype: pulumi.Output<boolean | undefined>;
/**
* The name of the Rule
*/
readonly name: pulumi.Output<string>;
/**
* The name of the generated Signals
*/
readonly nameExpression: pulumi.Output<string>;
/**
* The configuration of how the severity of the Signals should be mapped from the Records
*/
readonly severityMapping: pulumi.Output<outputs.CseMatchRuleSeverityMapping>;
/**
* 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 0 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>;
/**
* Create a CseMatchRule 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: CseMatchRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CseMatchRule resources.
*/
export interface CseMatchRuleState {
/**
* The description of the generated Signals
*/
descriptionExpression?: 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.CseMatchRuleEntitySelector>[]>;
/**
* The expression for which records to match on
*/
expression?: pulumi.Input<string>;
/**
* Whether the generated Signals should be prototype Signals
*/
isPrototype?: pulumi.Input<boolean>;
/**
* The name of the Rule
*/
name?: pulumi.Input<string>;
/**
* The name of the generated Signals
*/
nameExpression?: pulumi.Input<string>;
/**
* The configuration of how the severity of the Signals should be mapped from the Records
*/
severityMapping?: pulumi.Input<inputs.CseMatchRuleSeverityMapping>;
/**
* The summary of the generated Signals
*/
summaryExpression?: pulumi.Input<string>;
/**
* For how long to suppress Signal generation, in milliseconds. Must be greater than 0 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 set of arguments for constructing a CseMatchRule resource.
*/
export interface CseMatchRuleArgs {
/**
* The description of the generated Signals
*/
descriptionExpression: 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.CseMatchRuleEntitySelector>[]>;
/**
* The expression for which records to match on
*/
expression: pulumi.Input<string>;
/**
* Whether the generated Signals should be prototype Signals
*/
isPrototype?: pulumi.Input<boolean>;
/**
* The name of the Rule
*/
name?: pulumi.Input<string>;
/**
* The name of the generated Signals
*/
nameExpression: pulumi.Input<string>;
/**
* The configuration of how the severity of the Signals should be mapped from the Records
*/
severityMapping: pulumi.Input<inputs.CseMatchRuleSeverityMapping>;
/**
* The summary of the generated Signals
*/
summaryExpression?: pulumi.Input<string>;
/**
* For how long to suppress Signal generation, in milliseconds. Must be greater than 0 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>[]>;
}