1. Packages
  2. Coralogix Provider
  3. API Docs
  4. getRulesGroup
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.getRulesGroup

Explore with Pulumi AI

coralogix logo
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as coralogix from "@pulumi/coralogix";
    
    const importedRulesGroupExample = coralogix.getRulesGroup({
        id: coralogix_rules_group.rules_group_example.id,
    });
    
    import pulumi
    import pulumi_coralogix as coralogix
    
    imported_rules_group_example = coralogix.get_rules_group(id=coralogix_rules_group["rules_group_example"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coralogix/v2/coralogix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := coralogix.LookupRulesGroup(ctx, &coralogix.LookupRulesGroupArgs{
    			Id: coralogix_rules_group.Rules_group_example.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Coralogix = Pulumi.Coralogix;
    
    return await Deployment.RunAsync(() => 
    {
        var importedRulesGroupExample = Coralogix.GetRulesGroup.Invoke(new()
        {
            Id = coralogix_rules_group.Rules_group_example.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.coralogix.CoralogixFunctions;
    import com.pulumi.coralogix.inputs.GetRulesGroupArgs;
    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) {
            final var importedRulesGroupExample = CoralogixFunctions.getRulesGroup(GetRulesGroupArgs.builder()
                .id(coralogix_rules_group.rules_group_example().id())
                .build());
    
        }
    }
    
    variables:
      importedRulesGroupExample:
        fn::invoke:
          function: coralogix:getRulesGroup
          arguments:
            id: ${coralogix_rules_group.rules_group_example.id}
    

    Using getRulesGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRulesGroup(args: GetRulesGroupArgs, opts?: InvokeOptions): Promise<GetRulesGroupResult>
    function getRulesGroupOutput(args: GetRulesGroupOutputArgs, opts?: InvokeOptions): Output<GetRulesGroupResult>
    def get_rules_group(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRulesGroupResult
    def get_rules_group_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRulesGroupResult]
    func LookupRulesGroup(ctx *Context, args *LookupRulesGroupArgs, opts ...InvokeOption) (*LookupRulesGroupResult, error)
    func LookupRulesGroupOutput(ctx *Context, args *LookupRulesGroupOutputArgs, opts ...InvokeOption) LookupRulesGroupResultOutput

    > Note: This function is named LookupRulesGroup in the Go SDK.

    public static class GetRulesGroup 
    {
        public static Task<GetRulesGroupResult> InvokeAsync(GetRulesGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetRulesGroupResult> Invoke(GetRulesGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRulesGroupResult> getRulesGroup(GetRulesGroupArgs args, InvokeOptions options)
    public static Output<GetRulesGroupResult> getRulesGroup(GetRulesGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: coralogix:index/getRulesGroup:getRulesGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    getRulesGroup Result

    The following output properties are available:

    Active bool
    Determines whether the rule-group will be active.
    Applications List<string>
    Rules will execute on logs that match the following applications.
    Creator string
    Rule-group creator.
    Description string
    Rule-group description
    Hidden bool
    Id string
    The ID of this resource.
    Name string
    Rule-group name
    Order double
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    RuleSubgroups List<GetRulesGroupRuleSubgroup>
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    Severities List<string>
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    Subsystems List<string>
    Rules will execute on logs that match the following subsystems.
    Active bool
    Determines whether the rule-group will be active.
    Applications []string
    Rules will execute on logs that match the following applications.
    Creator string
    Rule-group creator.
    Description string
    Rule-group description
    Hidden bool
    Id string
    The ID of this resource.
    Name string
    Rule-group name
    Order float64
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    RuleSubgroups []GetRulesGroupRuleSubgroup
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    Severities []string
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    Subsystems []string
    Rules will execute on logs that match the following subsystems.
    active Boolean
    Determines whether the rule-group will be active.
    applications List<String>
    Rules will execute on logs that match the following applications.
    creator String
    Rule-group creator.
    description String
    Rule-group description
    hidden Boolean
    id String
    The ID of this resource.
    name String
    Rule-group name
    order Double
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    ruleSubgroups List<GetRulesGroupRuleSubgroup>
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    severities List<String>
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    subsystems List<String>
    Rules will execute on logs that match the following subsystems.
    active boolean
    Determines whether the rule-group will be active.
    applications string[]
    Rules will execute on logs that match the following applications.
    creator string
    Rule-group creator.
    description string
    Rule-group description
    hidden boolean
    id string
    The ID of this resource.
    name string
    Rule-group name
    order number
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    ruleSubgroups GetRulesGroupRuleSubgroup[]
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    severities string[]
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    subsystems string[]
    Rules will execute on logs that match the following subsystems.
    active bool
    Determines whether the rule-group will be active.
    applications Sequence[str]
    Rules will execute on logs that match the following applications.
    creator str
    Rule-group creator.
    description str
    Rule-group description
    hidden bool
    id str
    The ID of this resource.
    name str
    Rule-group name
    order float
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    rule_subgroups Sequence[GetRulesGroupRuleSubgroup]
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    severities Sequence[str]
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    subsystems Sequence[str]
    Rules will execute on logs that match the following subsystems.
    active Boolean
    Determines whether the rule-group will be active.
    applications List<String>
    Rules will execute on logs that match the following applications.
    creator String
    Rule-group creator.
    description String
    Rule-group description
    hidden Boolean
    id String
    The ID of this resource.
    name String
    Rule-group name
    order Number
    Determines the index of the rule-group between the other rule-groups. By default, will be added last. (1 based indexing).
    ruleSubgroups List<Property Map>
    List of rule-subgroups. Every rule-subgroup is a list of rules linked with a logical 'OR' (||) operation.
    severities List<String>
    Rules will execute on logs that match the these severities. Can be one of ["Critical" "Debug" "Error" "Info" "Verbose" "Warning"]
    subsystems List<String>
    Rules will execute on logs that match the following subsystems.

    Supporting Types

    GetRulesGroupRuleSubgroup

    GetRulesGroupRuleSubgroupRule

    GetRulesGroupRuleSubgroupRuleBlock

    active Boolean
    blockingAllMatchingBlocks Boolean
    description String
    id String
    keepBlockedLogs Boolean
    name String
    order Double
    regularExpression String
    sourceField String
    active boolean
    blockingAllMatchingBlocks boolean
    description string
    id string
    keepBlockedLogs boolean
    name string
    order number
    regularExpression string
    sourceField string
    active Boolean
    blockingAllMatchingBlocks Boolean
    description String
    id String
    keepBlockedLogs Boolean
    name String
    order Number
    regularExpression String
    sourceField String

    GetRulesGroupRuleSubgroupRuleExtract

    Active bool
    Description string
    Id string
    Name string
    Order double
    RegularExpression string
    SourceField string
    Active bool
    Description string
    Id string
    Name string
    Order float64
    RegularExpression string
    SourceField string
    active Boolean
    description String
    id String
    name String
    order Double
    regularExpression String
    sourceField String
    active boolean
    description string
    id string
    name string
    order number
    regularExpression string
    sourceField string
    active Boolean
    description String
    id String
    name String
    order Number
    regularExpression String
    sourceField String

    GetRulesGroupRuleSubgroupRuleExtractTimestamp

    Active bool
    Description string
    FieldFormatStandard string
    Id string
    Name string
    Order double
    SourceField string
    TimeFormat string
    Active bool
    Description string
    FieldFormatStandard string
    Id string
    Name string
    Order float64
    SourceField string
    TimeFormat string
    active Boolean
    description String
    fieldFormatStandard String
    id String
    name String
    order Double
    sourceField String
    timeFormat String
    active boolean
    description string
    fieldFormatStandard string
    id string
    name string
    order number
    sourceField string
    timeFormat string
    active Boolean
    description String
    fieldFormatStandard String
    id String
    name String
    order Number
    sourceField String
    timeFormat String

    GetRulesGroupRuleSubgroupRuleJsonExtract

    Active bool
    Description string
    DestinationField string
    DestinationFieldText string
    Id string
    JsonKey string
    Name string
    Order double
    Active bool
    Description string
    DestinationField string
    DestinationFieldText string
    Id string
    JsonKey string
    Name string
    Order float64
    active Boolean
    description String
    destinationField String
    destinationFieldText String
    id String
    jsonKey String
    name String
    order Double
    active boolean
    description string
    destinationField string
    destinationFieldText string
    id string
    jsonKey string
    name string
    order number
    active Boolean
    description String
    destinationField String
    destinationFieldText String
    id String
    jsonKey String
    name String
    order Number

    GetRulesGroupRuleSubgroupRuleJsonStringify

    Active bool
    Description string
    DestinationField string
    Id string
    KeepSourceField bool
    Name string
    Order double
    SourceField string
    Active bool
    Description string
    DestinationField string
    Id string
    KeepSourceField bool
    Name string
    Order float64
    SourceField string
    active Boolean
    description String
    destinationField String
    id String
    keepSourceField Boolean
    name String
    order Double
    sourceField String
    active boolean
    description string
    destinationField string
    id string
    keepSourceField boolean
    name string
    order number
    sourceField string
    active Boolean
    description String
    destinationField String
    id String
    keepSourceField Boolean
    name String
    order Number
    sourceField String

    GetRulesGroupRuleSubgroupRuleParse

    Active bool
    Description string
    DestinationField string
    Id string
    Name string
    Order double
    RegularExpression string
    SourceField string
    Active bool
    Description string
    DestinationField string
    Id string
    Name string
    Order float64
    RegularExpression string
    SourceField string
    active Boolean
    description String
    destinationField String
    id String
    name String
    order Double
    regularExpression String
    sourceField String
    active boolean
    description string
    destinationField string
    id string
    name string
    order number
    regularExpression string
    sourceField string
    active Boolean
    description String
    destinationField String
    id String
    name String
    order Number
    regularExpression String
    sourceField String

    GetRulesGroupRuleSubgroupRuleParseJsonField

    active Boolean
    description String
    destinationField String
    id String
    keepDestinationField Boolean
    keepSourceField Boolean
    name String
    order Double
    sourceField String
    active boolean
    description string
    destinationField string
    id string
    keepDestinationField boolean
    keepSourceField boolean
    name string
    order number
    sourceField string
    active Boolean
    description String
    destinationField String
    id String
    keepDestinationField Boolean
    keepSourceField Boolean
    name String
    order Number
    sourceField String

    GetRulesGroupRuleSubgroupRuleRemoveField

    Active bool
    Description string
    ExcludedFields List<string>
    Id string
    Name string
    Order double
    Active bool
    Description string
    ExcludedFields []string
    Id string
    Name string
    Order float64
    active Boolean
    description String
    excludedFields List<String>
    id String
    name String
    order Double
    active boolean
    description string
    excludedFields string[]
    id string
    name string
    order number
    active bool
    description str
    excluded_fields Sequence[str]
    id str
    name str
    order float
    active Boolean
    description String
    excludedFields List<String>
    id String
    name String
    order Number

    GetRulesGroupRuleSubgroupRuleReplace

    Active bool
    Description string
    DestinationField string
    Id string
    Name string
    Order double
    RegularExpression string
    ReplacementString string
    SourceField string
    Active bool
    Description string
    DestinationField string
    Id string
    Name string
    Order float64
    RegularExpression string
    ReplacementString string
    SourceField string
    active Boolean
    description String
    destinationField String
    id String
    name String
    order Double
    regularExpression String
    replacementString String
    sourceField String
    active boolean
    description string
    destinationField string
    id string
    name string
    order number
    regularExpression string
    replacementString string
    sourceField string
    active Boolean
    description String
    destinationField String
    id String
    name String
    order Number
    regularExpression String
    replacementString String
    sourceField String

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix