FieldExtractionRule

Provides a Sumologic Field Extraction Rule.

Attributes reference

The following attributes are exported:

  • id - Unique identifier for the field extraction rule.

Example Usage

using System.Collections.Generic;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var fieldExtractionRule = new SumoLogic.FieldExtractionRule("fieldExtractionRule", new()
    {
        Enabled = true,
        ParseExpression = "csv _raw extract 1 as f1",
        Scope = "_sourceHost=127.0.0.1",
    });

});
package main

import (
	"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewFieldExtractionRule(ctx, "fieldExtractionRule", &sumologic.FieldExtractionRuleArgs{
			Enabled:         pulumi.Bool(true),
			ParseExpression: pulumi.String("csv _raw extract 1 as f1"),
			Scope:           pulumi.String("_sourceHost=127.0.0.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.FieldExtractionRule;
import com.pulumi.sumologic.FieldExtractionRuleArgs;
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 fieldExtractionRule = new FieldExtractionRule("fieldExtractionRule", FieldExtractionRuleArgs.builder()        
            .enabled(true)
            .parseExpression("csv _raw extract 1 as f1")
            .scope("_sourceHost=127.0.0.1")
            .build());

    }
}
import pulumi
import pulumi_sumologic as sumologic

field_extraction_rule = sumologic.FieldExtractionRule("fieldExtractionRule",
    enabled=True,
    parse_expression="csv _raw extract 1 as f1",
    scope="_sourceHost=127.0.0.1")
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";

const fieldExtractionRule = new sumologic.FieldExtractionRule("fieldExtractionRule", {
    enabled: true,
    parseExpression: "csv _raw extract 1 as f1",
    scope: "_sourceHost=127.0.0.1",
});
resources:
  fieldExtractionRule:
    type: sumologic:FieldExtractionRule
    properties:
      enabled: true
      parseExpression: csv _raw extract 1 as f1
      scope: _sourceHost=127.0.0.1

Create FieldExtractionRule Resource

new FieldExtractionRule(name: string, args: FieldExtractionRuleArgs, opts?: CustomResourceOptions);
@overload
def FieldExtractionRule(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enabled: Optional[bool] = None,
                        name: Optional[str] = None,
                        parse_expression: Optional[str] = None,
                        scope: Optional[str] = None)
@overload
def FieldExtractionRule(resource_name: str,
                        args: FieldExtractionRuleArgs,
                        opts: Optional[ResourceOptions] = None)
func NewFieldExtractionRule(ctx *Context, name string, args FieldExtractionRuleArgs, opts ...ResourceOption) (*FieldExtractionRule, error)
public FieldExtractionRule(string name, FieldExtractionRuleArgs args, CustomResourceOptions? opts = null)
public FieldExtractionRule(String name, FieldExtractionRuleArgs args)
public FieldExtractionRule(String name, FieldExtractionRuleArgs args, CustomResourceOptions options)
type: sumologic:FieldExtractionRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FieldExtractionRuleArgs
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 FieldExtractionRuleArgs
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 FieldExtractionRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FieldExtractionRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FieldExtractionRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FieldExtractionRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FieldExtractionRule resource accepts the following input properties:

Enabled bool

Is the field extraction rule enabled.

ParseExpression string

Describes the fields to be parsed.

Scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

Name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

Enabled bool

Is the field extraction rule enabled.

ParseExpression string

Describes the fields to be parsed.

Scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

Name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

enabled Boolean

Is the field extraction rule enabled.

parseExpression String

Describes the fields to be parsed.

scope String

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

name String

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

enabled boolean

Is the field extraction rule enabled.

parseExpression string

Describes the fields to be parsed.

scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

enabled bool

Is the field extraction rule enabled.

parse_expression str

Describes the fields to be parsed.

scope str

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

name str

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

enabled Boolean

Is the field extraction rule enabled.

parseExpression String

Describes the fields to be parsed.

scope String

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

name String

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the FieldExtractionRule resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing FieldExtractionRule Resource

Get an existing FieldExtractionRule 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?: FieldExtractionRuleState, opts?: CustomResourceOptions): FieldExtractionRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        parse_expression: Optional[str] = None,
        scope: Optional[str] = None) -> FieldExtractionRule
func GetFieldExtractionRule(ctx *Context, name string, id IDInput, state *FieldExtractionRuleState, opts ...ResourceOption) (*FieldExtractionRule, error)
public static FieldExtractionRule Get(string name, Input<string> id, FieldExtractionRuleState? state, CustomResourceOptions? opts = null)
public static FieldExtractionRule get(String name, Output<String> id, FieldExtractionRuleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
Enabled bool

Is the field extraction rule enabled.

Name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

ParseExpression string

Describes the fields to be parsed.

Scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

Enabled bool

Is the field extraction rule enabled.

Name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

ParseExpression string

Describes the fields to be parsed.

Scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

enabled Boolean

Is the field extraction rule enabled.

name String

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

parseExpression String

Describes the fields to be parsed.

scope String

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

enabled boolean

Is the field extraction rule enabled.

name string

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

parseExpression string

Describes the fields to be parsed.

scope string

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

enabled bool

Is the field extraction rule enabled.

name str

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

parse_expression str

Describes the fields to be parsed.

scope str

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

enabled Boolean

Is the field extraction rule enabled.

name String

Name of the field extraction rule. Use a name that makes it easy to identify the rule.

parseExpression String

Describes the fields to be parsed.

scope String

Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.

Import

Extraction Rules can be imported using the extraction rule id, e.g.hcl

 $ pulumi import sumologic:index/fieldExtractionRule:FieldExtractionRule fieldExtractionRule id

[1]https://help.sumologic.com/Manage/Field-Extractions

Package Details

Repository
https://github.com/pulumi/pulumi-sumologic
License
Apache-2.0
Notes

This Pulumi package is based on the sumologic Terraform Provider.