published on Wednesday, Nov 11, 2026 by sumologic
published on Wednesday, Nov 11, 2026 by sumologic
Provides a Sumo Logic CSE Match Rule created from a Sigma rule.
The Sigma rule is looked up by its ID and converted to a Sumo Logic match rule. The converted fields are copied into the new rule when it is created, and the rule is marked as originating from Sigma. Later changes to the parent Sigma rule are not applied to the created match rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";
const sigmaRule = new sumologic.CseSigmaRule("sigma_rule", {
sigmaId: "637f689e-b4a5-4a86-be0e-0100a0a33ba2",
enabled: true,
});
import pulumi
import pulumi_sumologic as sumologic
sigma_rule = sumologic.CseSigmaRule("sigma_rule",
sigma_id="637f689e-b4a5-4a86-be0e-0100a0a33ba2",
enabled=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/sumologic/v3/sumologic"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sumologic.NewCseSigmaRule(ctx, "sigma_rule", &sumologic.CseSigmaRuleArgs{
SigmaId: pulumi.String("637f689e-b4a5-4a86-be0e-0100a0a33ba2"),
Enabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sumologic = Pulumi.Sumologic;
return await Deployment.RunAsync(() =>
{
var sigmaRule = new Sumologic.CseSigmaRule("sigma_rule", new()
{
SigmaId = "637f689e-b4a5-4a86-be0e-0100a0a33ba2",
Enabled = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.CseSigmaRule;
import com.pulumi.sumologic.CseSigmaRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var sigmaRule = new CseSigmaRule("sigmaRule", CseSigmaRuleArgs.builder()
.sigmaId("637f689e-b4a5-4a86-be0e-0100a0a33ba2")
.enabled(true)
.build());
}
}
resources:
sigmaRule:
type: sumologic:CseSigmaRule
name: sigma_rule
properties:
sigmaId: 637f689e-b4a5-4a86-be0e-0100a0a33ba2
enabled: true
Example coming soon!
Any converted field can be overridden. Note that an empty list (for example tags = [] or no entity_selectors blocks) is treated as unset, so it keeps the converted Sigma value rather than clearing it.
Example of overriding fields:
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";
const sigmaRule = new sumologic.CseSigmaRule("sigma_rule", {
sigmaId: "637f689e-b4a5-4a86-be0e-0100a0a33ba2",
enabled: true,
name: "My Sigma Rule",
isPrototype: false,
tags: ["_mitreAttackTactic:TA0004"],
});
import pulumi
import pulumi_sumologic as sumologic
sigma_rule = sumologic.CseSigmaRule("sigma_rule",
sigma_id="637f689e-b4a5-4a86-be0e-0100a0a33ba2",
enabled=True,
name="My Sigma Rule",
is_prototype=False,
tags=["_mitreAttackTactic:TA0004"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/sumologic/v3/sumologic"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sumologic.NewCseSigmaRule(ctx, "sigma_rule", &sumologic.CseSigmaRuleArgs{
SigmaId: pulumi.String("637f689e-b4a5-4a86-be0e-0100a0a33ba2"),
Enabled: pulumi.Bool(true),
Name: pulumi.String("My Sigma Rule"),
IsPrototype: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("_mitreAttackTactic:TA0004"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sumologic = Pulumi.Sumologic;
return await Deployment.RunAsync(() =>
{
var sigmaRule = new Sumologic.CseSigmaRule("sigma_rule", new()
{
SigmaId = "637f689e-b4a5-4a86-be0e-0100a0a33ba2",
Enabled = true,
Name = "My Sigma Rule",
IsPrototype = false,
Tags = new[]
{
"_mitreAttackTactic:TA0004",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.CseSigmaRule;
import com.pulumi.sumologic.CseSigmaRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var sigmaRule = new CseSigmaRule("sigmaRule", CseSigmaRuleArgs.builder()
.sigmaId("637f689e-b4a5-4a86-be0e-0100a0a33ba2")
.enabled(true)
.name("My Sigma Rule")
.isPrototype(false)
.tags("_mitreAttackTactic:TA0004")
.build());
}
}
resources:
sigmaRule:
type: sumologic:CseSigmaRule
name: sigma_rule
properties:
sigmaId: 637f689e-b4a5-4a86-be0e-0100a0a33ba2
enabled: true
name: My Sigma Rule
isPrototype: false
tags:
- _mitreAttackTactic:TA0004
Example coming soon!
Create CseSigmaRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CseSigmaRule(name: string, args: CseSigmaRuleArgs, opts?: CustomResourceOptions);@overload
def CseSigmaRule(resource_name: str,
args: CseSigmaRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CseSigmaRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
sigma_id: Optional[str] = None,
entity_selectors: Optional[Sequence[CseSigmaRuleEntitySelectorArgs]] = None,
cse_sigma_rule_id: Optional[str] = None,
expression: Optional[str] = None,
is_prototype: Optional[bool] = None,
name: Optional[str] = None,
name_expression: Optional[str] = None,
severity_mapping: Optional[CseSigmaRuleSeverityMappingArgs] = None,
description_expression: Optional[str] = None,
summary_expression: Optional[str] = None,
suppression_window_size: Optional[float] = None,
tags: Optional[Sequence[str]] = None)func NewCseSigmaRule(ctx *Context, name string, args CseSigmaRuleArgs, opts ...ResourceOption) (*CseSigmaRule, error)public CseSigmaRule(string name, CseSigmaRuleArgs args, CustomResourceOptions? opts = null)
public CseSigmaRule(String name, CseSigmaRuleArgs args)
public CseSigmaRule(String name, CseSigmaRuleArgs args, CustomResourceOptions options)
type: sumologic:CseSigmaRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "sumologic_cse_sigma_rule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CseSigmaRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CseSigmaRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CseSigmaRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CseSigmaRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CseSigmaRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cseSigmaRuleResource = new Sumologic.CseSigmaRule("cseSigmaRuleResource", new()
{
Enabled = false,
SigmaId = "string",
EntitySelectors = new[]
{
new Sumologic.Inputs.CseSigmaRuleEntitySelectorArgs
{
EntityType = "string",
Expression = "string",
},
},
CseSigmaRuleId = "string",
Expression = "string",
IsPrototype = false,
Name = "string",
NameExpression = "string",
SeverityMapping = new Sumologic.Inputs.CseSigmaRuleSeverityMappingArgs
{
Type = "string",
Default = 0.0,
Field = "string",
Mappings = new[]
{
new Sumologic.Inputs.CseSigmaRuleSeverityMappingMappingArgs
{
From = "string",
To = 0.0,
Type = "string",
},
},
},
DescriptionExpression = "string",
SummaryExpression = "string",
SuppressionWindowSize = 0.0,
Tags = new[]
{
"string",
},
});
example, err := sumologic.NewCseSigmaRule(ctx, "cseSigmaRuleResource", &sumologic.CseSigmaRuleArgs{
Enabled: pulumi.Bool(false),
SigmaId: pulumi.String("string"),
EntitySelectors: sumologic.CseSigmaRuleEntitySelectorArray{
&sumologic.CseSigmaRuleEntitySelectorArgs{
EntityType: pulumi.String("string"),
Expression: pulumi.String("string"),
},
},
CseSigmaRuleId: pulumi.String("string"),
Expression: pulumi.String("string"),
IsPrototype: pulumi.Bool(false),
Name: pulumi.String("string"),
NameExpression: pulumi.String("string"),
SeverityMapping: &sumologic.CseSigmaRuleSeverityMappingArgs{
Type: pulumi.String("string"),
Default: pulumi.Float64(0),
Field: pulumi.String("string"),
Mappings: sumologic.CseSigmaRuleSeverityMappingMappingArray{
&sumologic.CseSigmaRuleSeverityMappingMappingArgs{
From: pulumi.String("string"),
To: pulumi.Float64(0),
Type: pulumi.String("string"),
},
},
},
DescriptionExpression: pulumi.String("string"),
SummaryExpression: pulumi.String("string"),
SuppressionWindowSize: pulumi.Float64(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "sumologic_cse_sigma_rule" "cseSigmaRuleResource" {
lifecycle {
create_before_destroy = true
}
enabled = false
sigma_id = "string"
entity_selectors {
entity_type = "string"
expression = "string"
}
cse_sigma_rule_id = "string"
expression = "string"
is_prototype = false
name = "string"
name_expression = "string"
severity_mapping = {
type = "string"
default = 0
field = "string"
mappings = [{
from = "string"
to = 0
type = "string"
}]
}
description_expression = "string"
summary_expression = "string"
suppression_window_size = 0
tags = ["string"]
}
var cseSigmaRuleResource = new CseSigmaRule("cseSigmaRuleResource", CseSigmaRuleArgs.builder()
.enabled(false)
.sigmaId("string")
.entitySelectors(CseSigmaRuleEntitySelectorArgs.builder()
.entityType("string")
.expression("string")
.build())
.cseSigmaRuleId("string")
.expression("string")
.isPrototype(false)
.name("string")
.nameExpression("string")
.severityMapping(CseSigmaRuleSeverityMappingArgs.builder()
.type("string")
.default_(0.0)
.field("string")
.mappings(CseSigmaRuleSeverityMappingMappingArgs.builder()
.from("string")
.to(0.0)
.type("string")
.build())
.build())
.descriptionExpression("string")
.summaryExpression("string")
.suppressionWindowSize(0.0)
.tags("string")
.build());
cse_sigma_rule_resource = sumologic.CseSigmaRule("cseSigmaRuleResource",
enabled=False,
sigma_id="string",
entity_selectors=[{
"entity_type": "string",
"expression": "string",
}],
cse_sigma_rule_id="string",
expression="string",
is_prototype=False,
name="string",
name_expression="string",
severity_mapping={
"type": "string",
"default": float(0),
"field": "string",
"mappings": [{
"from_": "string",
"to": float(0),
"type": "string",
}],
},
description_expression="string",
summary_expression="string",
suppression_window_size=float(0),
tags=["string"])
const cseSigmaRuleResource = new sumologic.CseSigmaRule("cseSigmaRuleResource", {
enabled: false,
sigmaId: "string",
entitySelectors: [{
entityType: "string",
expression: "string",
}],
cseSigmaRuleId: "string",
expression: "string",
isPrototype: false,
name: "string",
nameExpression: "string",
severityMapping: {
type: "string",
"default": 0,
field: "string",
mappings: [{
from: "string",
to: 0,
type: "string",
}],
},
descriptionExpression: "string",
summaryExpression: "string",
suppressionWindowSize: 0,
tags: ["string"],
});
type: sumologic:CseSigmaRule
properties:
cseSigmaRuleId: string
descriptionExpression: string
enabled: false
entitySelectors:
- entityType: string
expression: string
expression: string
isPrototype: false
name: string
nameExpression: string
severityMapping:
default: 0
field: string
mappings:
- from: string
to: 0
type: string
type: string
sigmaId: string
summaryExpression: string
suppressionWindowSize: 0
tags:
- string
CseSigmaRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CseSigmaRule resource accepts the following input properties:
- Enabled bool
- Whether the rule should generate Signals
- Sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- Cse
Sigma stringRule Id - The internal ID of the rule.
- Description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- Entity
Selectors List<CseSigma Rule Entity Selector> - The entities to generate Signals on. Defaults to the converted Sigma value.
- Expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- Is
Prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- Name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- Name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- Severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- Summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- Suppression
Window doubleSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<string>
- The tags of the generated Signals. Defaults to the converted Sigma value.
- Enabled bool
- Whether the rule should generate Signals
- Sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- Cse
Sigma stringRule Id - The internal ID of the rule.
- Description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- Entity
Selectors []CseSigma Rule Entity Selector Args - The entities to generate Signals on. Defaults to the converted Sigma value.
- Expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- Is
Prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- Name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- Name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- Severity
Mapping CseSigma Rule Severity Mapping Args - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- Summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- Suppression
Window float64Size For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- []string
- The tags of the generated Signals. Defaults to the converted Sigma value.
- enabled bool
- Whether the rule should generate Signals
- sigma_
id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- cse_
sigma_ stringrule_ id - The internal ID of the rule.
- description_
expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- entity_
selectors list(object) - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- is_
prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- name_
expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- severity_
mapping object - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- summary_
expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression_
window_ numbersize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- list(string)
- The tags of the generated Signals. Defaults to the converted Sigma value.
- enabled Boolean
- Whether the rule should generate Signals
- sigma
Id String - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- cse
Sigma StringRule Id - The internal ID of the rule.
- description
Expression String - The description of the generated Signals. Defaults to the converted Sigma value.
- entity
Selectors List<CseSigma Rule Entity Selector> - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression String
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype Boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name String
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression String - The name of the generated Signals. Defaults to the converted Sigma value.
- severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- summary
Expression String - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window DoubleSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<String>
- The tags of the generated Signals. Defaults to the converted Sigma value.
- enabled boolean
- Whether the rule should generate Signals
- sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- cse
Sigma stringRule Id - The internal ID of the rule.
- description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- entity
Selectors CseSigma Rule Entity Selector[] - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window numberSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- string[]
- The tags of the generated Signals. Defaults to the converted Sigma value.
- enabled bool
- Whether the rule should generate Signals
- sigma_
id str - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- cse_
sigma_ strrule_ id - The internal ID of the rule.
- description_
expression str - The description of the generated Signals. Defaults to the converted Sigma value.
- entity_
selectors Sequence[CseSigma Rule Entity Selector Args] - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression str
- The expression for which records to match on. Defaults to the converted Sigma value.
- is_
prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name str
- The name of the Rule. Defaults to the name of the Sigma rule.
- name_
expression str - The name of the generated Signals. Defaults to the converted Sigma value.
- severity_
mapping CseSigma Rule Severity Mapping Args - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- summary_
expression str - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression_
window_ floatsize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- Sequence[str]
- The tags of the generated Signals. Defaults to the converted Sigma value.
- enabled Boolean
- Whether the rule should generate Signals
- sigma
Id String - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- cse
Sigma StringRule Id - The internal ID of the rule.
- description
Expression String - The description of the generated Signals. Defaults to the converted Sigma value.
- entity
Selectors List<Property Map> - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression String
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype Boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name String
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression String - The name of the generated Signals. Defaults to the converted Sigma value.
- severity
Mapping Property Map - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- summary
Expression String - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window NumberSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<String>
- The tags of the generated Signals. Defaults to the converted Sigma value.
Outputs
All input properties are implicitly available as output properties. Additionally, the CseSigmaRule resource produces the following output properties:
- Category string
- The category of the rule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Original
Source string - The original source of the rule. Always
sigma.
- Category string
- The category of the rule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Original
Source string - The original source of the rule. Always
sigma.
- category string
- The category of the rule.
- id string
- The provider-assigned unique ID for this managed resource.
- original_
source string - The original source of the rule. Always
sigma.
- category String
- The category of the rule.
- id String
- The provider-assigned unique ID for this managed resource.
- original
Source String - The original source of the rule. Always
sigma.
- category string
- The category of the rule.
- id string
- The provider-assigned unique ID for this managed resource.
- original
Source string - The original source of the rule. Always
sigma.
- category str
- The category of the rule.
- id str
- The provider-assigned unique ID for this managed resource.
- original_
source str - The original source of the rule. Always
sigma.
- category String
- The category of the rule.
- id String
- The provider-assigned unique ID for this managed resource.
- original
Source String - The original source of the rule. Always
sigma.
Look up Existing CseSigmaRule Resource
Get an existing CseSigmaRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CseSigmaRuleState, opts?: CustomResourceOptions): CseSigmaRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
category: Optional[str] = None,
cse_sigma_rule_id: Optional[str] = None,
description_expression: Optional[str] = None,
enabled: Optional[bool] = None,
entity_selectors: Optional[Sequence[CseSigmaRuleEntitySelectorArgs]] = None,
expression: Optional[str] = None,
is_prototype: Optional[bool] = None,
name: Optional[str] = None,
name_expression: Optional[str] = None,
original_source: Optional[str] = None,
severity_mapping: Optional[CseSigmaRuleSeverityMappingArgs] = None,
sigma_id: Optional[str] = None,
summary_expression: Optional[str] = None,
suppression_window_size: Optional[float] = None,
tags: Optional[Sequence[str]] = None) -> CseSigmaRulefunc GetCseSigmaRule(ctx *Context, name string, id IDInput, state *CseSigmaRuleState, opts ...ResourceOption) (*CseSigmaRule, error)public static CseSigmaRule Get(string name, Input<string> id, CseSigmaRuleState? state, CustomResourceOptions? opts = null)public static CseSigmaRule get(String name, Output<String> id, CseSigmaRuleState state, CustomResourceOptions options)resources: _: type: sumologic:CseSigmaRule get: id: ${id}import {
to = sumologic_cse_sigma_rule.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Category string
- The category of the rule.
- Cse
Sigma stringRule Id - The internal ID of the rule.
- Description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- Enabled bool
- Whether the rule should generate Signals
- Entity
Selectors List<CseSigma Rule Entity Selector> - The entities to generate Signals on. Defaults to the converted Sigma value.
- Expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- Is
Prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- Name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- Name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- Original
Source string - The original source of the rule. Always
sigma. - Severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- Sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- Summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- Suppression
Window doubleSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<string>
- The tags of the generated Signals. Defaults to the converted Sigma value.
- Category string
- The category of the rule.
- Cse
Sigma stringRule Id - The internal ID of the rule.
- Description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- Enabled bool
- Whether the rule should generate Signals
- Entity
Selectors []CseSigma Rule Entity Selector Args - The entities to generate Signals on. Defaults to the converted Sigma value.
- Expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- Is
Prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- Name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- Name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- Original
Source string - The original source of the rule. Always
sigma. - Severity
Mapping CseSigma Rule Severity Mapping Args - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- Sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- Summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- Suppression
Window float64Size For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- []string
- The tags of the generated Signals. Defaults to the converted Sigma value.
- category string
- The category of the rule.
- cse_
sigma_ stringrule_ id - The internal ID of the rule.
- description_
expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- enabled bool
- Whether the rule should generate Signals
- entity_
selectors list(object) - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- is_
prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- name_
expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- original_
source string - The original source of the rule. Always
sigma. - severity_
mapping object - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- sigma_
id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- summary_
expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression_
window_ numbersize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- list(string)
- The tags of the generated Signals. Defaults to the converted Sigma value.
- category String
- The category of the rule.
- cse
Sigma StringRule Id - The internal ID of the rule.
- description
Expression String - The description of the generated Signals. Defaults to the converted Sigma value.
- enabled Boolean
- Whether the rule should generate Signals
- entity
Selectors List<CseSigma Rule Entity Selector> - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression String
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype Boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name String
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression String - The name of the generated Signals. Defaults to the converted Sigma value.
- original
Source String - The original source of the rule. Always
sigma. - severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- sigma
Id String - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- summary
Expression String - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window DoubleSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<String>
- The tags of the generated Signals. Defaults to the converted Sigma value.
- category string
- The category of the rule.
- cse
Sigma stringRule Id - The internal ID of the rule.
- description
Expression string - The description of the generated Signals. Defaults to the converted Sigma value.
- enabled boolean
- Whether the rule should generate Signals
- entity
Selectors CseSigma Rule Entity Selector[] - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression string
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name string
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression string - The name of the generated Signals. Defaults to the converted Sigma value.
- original
Source string - The original source of the rule. Always
sigma. - severity
Mapping CseSigma Rule Severity Mapping - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- sigma
Id string - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- summary
Expression string - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window numberSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- string[]
- The tags of the generated Signals. Defaults to the converted Sigma value.
- category str
- The category of the rule.
- cse_
sigma_ strrule_ id - The internal ID of the rule.
- description_
expression str - The description of the generated Signals. Defaults to the converted Sigma value.
- enabled bool
- Whether the rule should generate Signals
- entity_
selectors Sequence[CseSigma Rule Entity Selector Args] - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression str
- The expression for which records to match on. Defaults to the converted Sigma value.
- is_
prototype bool - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name str
- The name of the Rule. Defaults to the name of the Sigma rule.
- name_
expression str - The name of the generated Signals. Defaults to the converted Sigma value.
- original_
source str - The original source of the rule. Always
sigma. - severity_
mapping CseSigma Rule Severity Mapping Args - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- sigma_
id str - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- summary_
expression str - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression_
window_ floatsize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- Sequence[str]
- The tags of the generated Signals. Defaults to the converted Sigma value.
- category String
- The category of the rule.
- cse
Sigma StringRule Id - The internal ID of the rule.
- description
Expression String - The description of the generated Signals. Defaults to the converted Sigma value.
- enabled Boolean
- Whether the rule should generate Signals
- entity
Selectors List<Property Map> - The entities to generate Signals on. Defaults to the converted Sigma value.
- expression String
- The expression for which records to match on. Defaults to the converted Sigma value.
- is
Prototype Boolean - Whether the generated Signals should be prototype Signals. Defaults to the converted Sigma value.
- name String
- The name of the Rule. Defaults to the name of the Sigma rule.
- name
Expression String - The name of the generated Signals. Defaults to the converted Sigma value.
- original
Source String - The original source of the rule. Always
sigma. - severity
Mapping Property Map - The configuration of how the severity of the Signals should be mapped from the Records. Defaults to the converted Sigma value.
- sigma
Id String - The ID (UUID) of the Sigma rule to import. Changing this forces a new rule to be created.
- summary
Expression String - The summary of the generated Signals. Defaults to the converted Sigma value.
- suppression
Window NumberSize For how long to suppress Signal generation, in milliseconds. Must be between 0 and the global limit of 7 days.
The following attributes are exported:
- List<String>
- The tags of the generated Signals. Defaults to the converted Sigma value.
Supporting Types
CseSigmaRuleEntitySelector, CseSigmaRuleEntitySelectorArgs
- Entity
Type string - The type of the entity to generate the Signal on.
- Expression string
- The expression or field name to generate the Signal on.
- Entity
Type string - The type of the entity to generate the Signal on.
- Expression string
- The expression or field name to generate the Signal on.
- entity_
type string - The type of the entity to generate the Signal on.
- expression string
- The expression or field name to generate the Signal on.
- entity
Type String - The type of the entity to generate the Signal on.
- expression String
- The expression or field name to generate the Signal on.
- entity
Type string - The type of the entity to generate the Signal on.
- expression string
- The expression or field name to generate the Signal on.
- entity_
type str - The type of the entity to generate the Signal on.
- expression str
- The expression or field name to generate the Signal on.
- entity
Type String - The type of the entity to generate the Signal on.
- expression String
- The expression or field name to generate the Signal on.
CseSigmaRuleSeverityMapping, CseSigmaRuleSeverityMappingArgs
- Type string
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- Default double
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- Field string
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- Mappings
List<Cse
Sigma Rule Severity Mapping Mapping> - The map of record values to severities to use in the "fieldValueMapping" case
- Type string
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- Default float64
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- Field string
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- Mappings
[]Cse
Sigma Rule Severity Mapping Mapping - The map of record values to severities to use in the "fieldValueMapping" case
- type string
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- default number
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- field string
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- mappings list(object)
- The map of record values to severities to use in the "fieldValueMapping" case
- type String
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- default_ Double
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- field String
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- mappings
List<Cse
Sigma Rule Severity Mapping Mapping> - The map of record values to severities to use in the "fieldValueMapping" case
- type string
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- default number
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- field string
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- mappings
Cse
Sigma Rule Severity Mapping Mapping[] - The map of record values to severities to use in the "fieldValueMapping" case
- type str
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- default float
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- field str
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- mappings
Sequence[Cse
Sigma Rule Severity Mapping Mapping] - The map of record values to severities to use in the "fieldValueMapping" case
- type String
- Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
- default Number
- The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
- field String
- The field to use in the "fieldValue"/"fieldValueMapping" cases.
- mappings List<Property Map>
- The map of record values to severities to use in the "fieldValueMapping" case
CseSigmaRuleSeverityMappingMapping, CseSigmaRuleSeverityMappingMappingArgs
Import
Importing is not supported, because the Sigma ID cannot be read back from an existing rule.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Sumo Logic sumologic/terraform-provider-sumologic
- License
- Notes
- This Pulumi package is based on the
sumologicTerraform Provider.
published on Wednesday, Nov 11, 2026 by sumologic