@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
207 lines (206 loc) • 7.5 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 Custom Insight.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const customInsight = new sumologic.CseCustomInsight("custom_insight", {
* description: "Insight description",
* enabled: true,
* ordered: true,
* name: "Custom Insight Example",
* ruleIds: [
* "MATCH-S00001",
* "THRESHOLD-U00005",
* ],
* severity: "HIGH",
* signalMatchStrategy: "ENTITY",
* dynamicSeverities: [{
* minimumSignalSeverity: 8,
* insightSeverity: "CRITICAL",
* }],
* signalNames: [
* "Some Signal Name",
* "Wildcard Signal Name *",
* ],
* tags: ["_mitreAttackTactic:TA0009"],
* });
* ```
*
* ## Import
*
* Custom Insights can be imported using the field id, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/cseCustomInsight:CseCustomInsight custom_insight id
* ```
*/
export declare class CseCustomInsight extends pulumi.CustomResource {
/**
* Get an existing CseCustomInsight 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?: CseCustomInsightState, opts?: pulumi.CustomResourceOptions): CseCustomInsight;
/**
* Returns true if the given object is an instance of CseCustomInsight. 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 CseCustomInsight;
/**
* The description of the generated Insights
*/
readonly description: pulumi.Output<string>;
/**
* The severity of the generated Insight that is based on the severity of the Signals that trigger the Insight.
*/
readonly dynamicSeverities: pulumi.Output<outputs.CseCustomInsightDynamicSeverity[] | undefined>;
/**
* Whether the Custom Insight should generate Insights
*/
readonly enabled: pulumi.Output<boolean>;
/**
* The name of the Custom Insight and the generated Insights
*/
readonly name: pulumi.Output<string>;
/**
* Whether the signals matching the rule IDs/signal names must be in the same chronological order as they are listed in the Custom Insight
*/
readonly ordered: pulumi.Output<boolean>;
/**
* The Rule IDs to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
readonly ruleIds: pulumi.Output<string[] | undefined>;
/**
* The severity of the generated Insights (CRITICAL, HIGH, MEDIUM, or LOW)
*/
readonly severity: pulumi.Output<string>;
/**
* The signal match strategy to use when generating insights (ENTITY, STRICT)
*/
readonly signalMatchStrategy: pulumi.Output<string | undefined>;
/**
* The Signal names to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
readonly signalNames: pulumi.Output<string[] | undefined>;
/**
* The tags of the generated Insights
*
* The following attributes are exported:
*/
readonly tags: pulumi.Output<string[]>;
/**
* Create a CseCustomInsight 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: CseCustomInsightArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CseCustomInsight resources.
*/
export interface CseCustomInsightState {
/**
* The description of the generated Insights
*/
description?: pulumi.Input<string>;
/**
* The severity of the generated Insight that is based on the severity of the Signals that trigger the Insight.
*/
dynamicSeverities?: pulumi.Input<pulumi.Input<inputs.CseCustomInsightDynamicSeverity>[]>;
/**
* Whether the Custom Insight should generate Insights
*/
enabled?: pulumi.Input<boolean>;
/**
* The name of the Custom Insight and the generated Insights
*/
name?: pulumi.Input<string>;
/**
* Whether the signals matching the rule IDs/signal names must be in the same chronological order as they are listed in the Custom Insight
*/
ordered?: pulumi.Input<boolean>;
/**
* The Rule IDs to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
ruleIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The severity of the generated Insights (CRITICAL, HIGH, MEDIUM, or LOW)
*/
severity?: pulumi.Input<string>;
/**
* The signal match strategy to use when generating insights (ENTITY, STRICT)
*/
signalMatchStrategy?: pulumi.Input<string>;
/**
* The Signal names to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
signalNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The tags of the generated Insights
*
* The following attributes are exported:
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a CseCustomInsight resource.
*/
export interface CseCustomInsightArgs {
/**
* The description of the generated Insights
*/
description: pulumi.Input<string>;
/**
* The severity of the generated Insight that is based on the severity of the Signals that trigger the Insight.
*/
dynamicSeverities?: pulumi.Input<pulumi.Input<inputs.CseCustomInsightDynamicSeverity>[]>;
/**
* Whether the Custom Insight should generate Insights
*/
enabled: pulumi.Input<boolean>;
/**
* The name of the Custom Insight and the generated Insights
*/
name?: pulumi.Input<string>;
/**
* Whether the signals matching the rule IDs/signal names must be in the same chronological order as they are listed in the Custom Insight
*/
ordered: pulumi.Input<boolean>;
/**
* The Rule IDs to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
ruleIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The severity of the generated Insights (CRITICAL, HIGH, MEDIUM, or LOW)
*/
severity: pulumi.Input<string>;
/**
* The signal match strategy to use when generating insights (ENTITY, STRICT)
*/
signalMatchStrategy?: pulumi.Input<string>;
/**
* The Signal names to match to generate an Insight (exactly one of ruleIds or signalNames must be specified)
*/
signalNames?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The tags of the generated Insights
*
* The following attributes are exported:
*/
tags: pulumi.Input<pulumi.Input<string>[]>;
}