Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.LogAnalytics.LogAnalyticsObjectCollectionRule

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLogAnalyticsObjectCollectionRule = new oci.loganalytics.LogAnalyticsObjectCollectionRule("test_log_analytics_object_collection_rule", {
    compartmentId: compartmentId,
    logGroupId: testLogGroup.id,
    logSourceName: logAnalyticsObjectCollectionRuleLogSourceName,
    name: logAnalyticsObjectCollectionRuleName,
    namespace: logAnalyticsObjectCollectionRuleNamespace,
    osBucketName: testBucket.name,
    osNamespace: logAnalyticsObjectCollectionRuleOsNamespace,
    charEncoding: logAnalyticsObjectCollectionRuleCharEncoding,
    collectionType: logAnalyticsObjectCollectionRuleCollectionType,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: logAnalyticsObjectCollectionRuleDescription,
    entityId: testEntity.id,
    freeformTags: {
        "bar-key": "value",
    },
    isEnabled: logAnalyticsObjectCollectionRuleIsEnabled,
    isForceHistoricCollection: logAnalyticsObjectCollectionRuleIsForceHistoricCollection,
    logSet: logAnalyticsObjectCollectionRuleLogSet,
    logSetExtRegex: logAnalyticsObjectCollectionRuleLogSetExtRegex,
    logSetKey: logAnalyticsObjectCollectionRuleLogSetKey,
    logType: logAnalyticsObjectCollectionRuleLogType,
    objectNameFilters: logAnalyticsObjectCollectionRuleObjectNameFilters,
    overrides: logAnalyticsObjectCollectionRuleOverrides,
    pollSince: logAnalyticsObjectCollectionRulePollSince,
    pollTill: logAnalyticsObjectCollectionRulePollTill,
    timezone: logAnalyticsObjectCollectionRuleTimezone,
});

import pulumi
import pulumi_oci as oci

test_log_analytics_object_collection_rule = oci.log_analytics.LogAnalyticsObjectCollectionRule("test_log_analytics_object_collection_rule",
    compartment_id=compartment_id,
    log_group_id=test_log_group["id"],
    log_source_name=log_analytics_object_collection_rule_log_source_name,
    name=log_analytics_object_collection_rule_name,
    namespace=log_analytics_object_collection_rule_namespace,
    os_bucket_name=test_bucket["name"],
    os_namespace=log_analytics_object_collection_rule_os_namespace,
    char_encoding=log_analytics_object_collection_rule_char_encoding,
    collection_type=log_analytics_object_collection_rule_collection_type,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=log_analytics_object_collection_rule_description,
    entity_id=test_entity["id"],
    freeform_tags={
        "bar-key": "value",
    },
    is_enabled=log_analytics_object_collection_rule_is_enabled,
    is_force_historic_collection=log_analytics_object_collection_rule_is_force_historic_collection,
    log_set=log_analytics_object_collection_rule_log_set,
    log_set_ext_regex=log_analytics_object_collection_rule_log_set_ext_regex,
    log_set_key=log_analytics_object_collection_rule_log_set_key,
    log_type=log_analytics_object_collection_rule_log_type,
    object_name_filters=log_analytics_object_collection_rule_object_name_filters,
    overrides=log_analytics_object_collection_rule_overrides,
    poll_since=log_analytics_object_collection_rule_poll_since,
    poll_till=log_analytics_object_collection_rule_poll_till,
    timezone=log_analytics_object_collection_rule_timezone)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loganalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loganalytics.NewLogAnalyticsObjectCollectionRule(ctx, "test_log_analytics_object_collection_rule", &loganalytics.LogAnalyticsObjectCollectionRuleArgs{
			CompartmentId:  pulumi.Any(compartmentId),
			LogGroupId:     pulumi.Any(testLogGroup.Id),
			LogSourceName:  pulumi.Any(logAnalyticsObjectCollectionRuleLogSourceName),
			Name:           pulumi.Any(logAnalyticsObjectCollectionRuleName),
			Namespace:      pulumi.Any(logAnalyticsObjectCollectionRuleNamespace),
			OsBucketName:   pulumi.Any(testBucket.Name),
			OsNamespace:    pulumi.Any(logAnalyticsObjectCollectionRuleOsNamespace),
			CharEncoding:   pulumi.Any(logAnalyticsObjectCollectionRuleCharEncoding),
			CollectionType: pulumi.Any(logAnalyticsObjectCollectionRuleCollectionType),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(logAnalyticsObjectCollectionRuleDescription),
			EntityId:    pulumi.Any(testEntity.Id),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsEnabled:                 pulumi.Any(logAnalyticsObjectCollectionRuleIsEnabled),
			IsForceHistoricCollection: pulumi.Any(logAnalyticsObjectCollectionRuleIsForceHistoricCollection),
			LogSet:                    pulumi.Any(logAnalyticsObjectCollectionRuleLogSet),
			LogSetExtRegex:            pulumi.Any(logAnalyticsObjectCollectionRuleLogSetExtRegex),
			LogSetKey:                 pulumi.Any(logAnalyticsObjectCollectionRuleLogSetKey),
			LogType:                   pulumi.Any(logAnalyticsObjectCollectionRuleLogType),
			ObjectNameFilters:         pulumi.Any(logAnalyticsObjectCollectionRuleObjectNameFilters),
			Overrides:                 pulumi.Any(logAnalyticsObjectCollectionRuleOverrides),
			PollSince:                 pulumi.Any(logAnalyticsObjectCollectionRulePollSince),
			PollTill:                  pulumi.Any(logAnalyticsObjectCollectionRulePollTill),
			Timezone:                  pulumi.Any(logAnalyticsObjectCollectionRuleTimezone),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsObjectCollectionRule = new Oci.LogAnalytics.LogAnalyticsObjectCollectionRule("test_log_analytics_object_collection_rule", new()
    {
        CompartmentId = compartmentId,
        LogGroupId = testLogGroup.Id,
        LogSourceName = logAnalyticsObjectCollectionRuleLogSourceName,
        Name = logAnalyticsObjectCollectionRuleName,
        Namespace = logAnalyticsObjectCollectionRuleNamespace,
        OsBucketName = testBucket.Name,
        OsNamespace = logAnalyticsObjectCollectionRuleOsNamespace,
        CharEncoding = logAnalyticsObjectCollectionRuleCharEncoding,
        CollectionType = logAnalyticsObjectCollectionRuleCollectionType,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = logAnalyticsObjectCollectionRuleDescription,
        EntityId = testEntity.Id,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsEnabled = logAnalyticsObjectCollectionRuleIsEnabled,
        IsForceHistoricCollection = logAnalyticsObjectCollectionRuleIsForceHistoricCollection,
        LogSet = logAnalyticsObjectCollectionRuleLogSet,
        LogSetExtRegex = logAnalyticsObjectCollectionRuleLogSetExtRegex,
        LogSetKey = logAnalyticsObjectCollectionRuleLogSetKey,
        LogType = logAnalyticsObjectCollectionRuleLogType,
        ObjectNameFilters = logAnalyticsObjectCollectionRuleObjectNameFilters,
        Overrides = logAnalyticsObjectCollectionRuleOverrides,
        PollSince = logAnalyticsObjectCollectionRulePollSince,
        PollTill = logAnalyticsObjectCollectionRulePollTill,
        Timezone = logAnalyticsObjectCollectionRuleTimezone,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LogAnalytics.LogAnalyticsObjectCollectionRule;
import com.pulumi.oci.LogAnalytics.LogAnalyticsObjectCollectionRuleArgs;
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 testLogAnalyticsObjectCollectionRule = new LogAnalyticsObjectCollectionRule("testLogAnalyticsObjectCollectionRule", LogAnalyticsObjectCollectionRuleArgs.builder()
            .compartmentId(compartmentId)
            .logGroupId(testLogGroup.id())
            .logSourceName(logAnalyticsObjectCollectionRuleLogSourceName)
            .name(logAnalyticsObjectCollectionRuleName)
            .namespace(logAnalyticsObjectCollectionRuleNamespace)
            .osBucketName(testBucket.name())
            .osNamespace(logAnalyticsObjectCollectionRuleOsNamespace)
            .charEncoding(logAnalyticsObjectCollectionRuleCharEncoding)
            .collectionType(logAnalyticsObjectCollectionRuleCollectionType)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(logAnalyticsObjectCollectionRuleDescription)
            .entityId(testEntity.id())
            .freeformTags(Map.of("bar-key", "value"))
            .isEnabled(logAnalyticsObjectCollectionRuleIsEnabled)
            .isForceHistoricCollection(logAnalyticsObjectCollectionRuleIsForceHistoricCollection)
            .logSet(logAnalyticsObjectCollectionRuleLogSet)
            .logSetExtRegex(logAnalyticsObjectCollectionRuleLogSetExtRegex)
            .logSetKey(logAnalyticsObjectCollectionRuleLogSetKey)
            .logType(logAnalyticsObjectCollectionRuleLogType)
            .objectNameFilters(logAnalyticsObjectCollectionRuleObjectNameFilters)
            .overrides(logAnalyticsObjectCollectionRuleOverrides)
            .pollSince(logAnalyticsObjectCollectionRulePollSince)
            .pollTill(logAnalyticsObjectCollectionRulePollTill)
            .timezone(logAnalyticsObjectCollectionRuleTimezone)
            .build());

    }
}

resources:
  testLogAnalyticsObjectCollectionRule:
    type: oci:LogAnalytics:LogAnalyticsObjectCollectionRule
    name: test_log_analytics_object_collection_rule
    properties:
      compartmentId: ${compartmentId}
      logGroupId: ${testLogGroup.id}
      logSourceName: ${logAnalyticsObjectCollectionRuleLogSourceName}
      name: ${logAnalyticsObjectCollectionRuleName}
      namespace: ${logAnalyticsObjectCollectionRuleNamespace}
      osBucketName: ${testBucket.name}
      osNamespace: ${logAnalyticsObjectCollectionRuleOsNamespace}
      charEncoding: ${logAnalyticsObjectCollectionRuleCharEncoding}
      collectionType: ${logAnalyticsObjectCollectionRuleCollectionType}
      definedTags:
        foo-namespace.bar-key: value
      description: ${logAnalyticsObjectCollectionRuleDescription}
      entityId: ${testEntity.id}
      freeformTags:
        bar-key: value
      isEnabled: ${logAnalyticsObjectCollectionRuleIsEnabled}
      isForceHistoricCollection: ${logAnalyticsObjectCollectionRuleIsForceHistoricCollection}
      logSet: ${logAnalyticsObjectCollectionRuleLogSet}
      logSetExtRegex: ${logAnalyticsObjectCollectionRuleLogSetExtRegex}
      logSetKey: ${logAnalyticsObjectCollectionRuleLogSetKey}
      logType: ${logAnalyticsObjectCollectionRuleLogType}
      objectNameFilters: ${logAnalyticsObjectCollectionRuleObjectNameFilters}
      overrides: ${logAnalyticsObjectCollectionRuleOverrides}
      pollSince: ${logAnalyticsObjectCollectionRulePollSince}
      pollTill: ${logAnalyticsObjectCollectionRulePollTill}
      timezone: ${logAnalyticsObjectCollectionRuleTimezone}

Create LogAnalyticsObjectCollectionRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LogAnalyticsObjectCollectionRule(name: string, args: LogAnalyticsObjectCollectionRuleArgs, opts?: CustomResourceOptions);

@overload
def LogAnalyticsObjectCollectionRule(resource_name: str,
                                     args: LogAnalyticsObjectCollectionRuleArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def LogAnalyticsObjectCollectionRule(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     log_group_id: Optional[str] = None,
                                     os_namespace: Optional[str] = None,
                                     compartment_id: Optional[str] = None,
                                     os_bucket_name: Optional[str] = None,
                                     namespace: Optional[str] = None,
                                     log_source_name: Optional[str] = None,
                                     freeform_tags: Optional[Mapping[str, str]] = None,
                                     name: Optional[str] = None,
                                     is_force_historic_collection: Optional[bool] = None,
                                     char_encoding: Optional[str] = None,
                                     log_set: Optional[str] = None,
                                     log_set_ext_regex: Optional[str] = None,
                                     log_set_key: Optional[str] = None,
                                     entity_id: Optional[str] = None,
                                     log_type: Optional[str] = None,
                                     is_enabled: Optional[bool] = None,
                                     description: Optional[str] = None,
                                     object_name_filters: Optional[Sequence[str]] = None,
                                     defined_tags: Optional[Mapping[str, str]] = None,
                                     collection_type: Optional[str] = None,
                                     overrides: Optional[Sequence[LogAnalyticsObjectCollectionRuleOverrideArgs]] = None,
                                     poll_since: Optional[str] = None,
                                     poll_till: Optional[str] = None,
                                     timezone: Optional[str] = None)

func NewLogAnalyticsObjectCollectionRule(ctx *Context, name string, args LogAnalyticsObjectCollectionRuleArgs, opts ...ResourceOption) (*LogAnalyticsObjectCollectionRule, error)

public LogAnalyticsObjectCollectionRule(string name, LogAnalyticsObjectCollectionRuleArgs args, CustomResourceOptions? opts = null)

public LogAnalyticsObjectCollectionRule(String name, LogAnalyticsObjectCollectionRuleArgs args)
public LogAnalyticsObjectCollectionRule(String name, LogAnalyticsObjectCollectionRuleArgs args, CustomResourceOptions options)

type: oci:LogAnalytics:LogAnalyticsObjectCollectionRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

name string: The unique name of the resource.
args LogAnalyticsObjectCollectionRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LogAnalyticsObjectCollectionRuleArgs: 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 logAnalyticsObjectCollectionRuleResource = new Oci.LogAnalytics.LogAnalyticsObjectCollectionRule("logAnalyticsObjectCollectionRuleResource", new()
{
    LogGroupId = "string",
    OsNamespace = "string",
    CompartmentId = "string",
    OsBucketName = "string",
    Namespace = "string",
    LogSourceName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
    IsForceHistoricCollection = false,
    CharEncoding = "string",
    LogSet = "string",
    LogSetExtRegex = "string",
    LogSetKey = "string",
    EntityId = "string",
    LogType = "string",
    IsEnabled = false,
    Description = "string",
    ObjectNameFilters = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    CollectionType = "string",
    Overrides = new[]
    {
        new Oci.LogAnalytics.Inputs.LogAnalyticsObjectCollectionRuleOverrideArgs
        {
            MatchType = "string",
            MatchValue = "string",
            PropertyName = "string",
            PropertyValue = "string",
        },
    },
    PollSince = "string",
    PollTill = "string",
    Timezone = "string",
});

example, err := loganalytics.NewLogAnalyticsObjectCollectionRule(ctx, "logAnalyticsObjectCollectionRuleResource", &loganalytics.LogAnalyticsObjectCollectionRuleArgs{
	LogGroupId:    pulumi.String("string"),
	OsNamespace:   pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	OsBucketName:  pulumi.String("string"),
	Namespace:     pulumi.String("string"),
	LogSourceName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:                      pulumi.String("string"),
	IsForceHistoricCollection: pulumi.Bool(false),
	CharEncoding:              pulumi.String("string"),
	LogSet:                    pulumi.String("string"),
	LogSetExtRegex:            pulumi.String("string"),
	LogSetKey:                 pulumi.String("string"),
	EntityId:                  pulumi.String("string"),
	LogType:                   pulumi.String("string"),
	IsEnabled:                 pulumi.Bool(false),
	Description:               pulumi.String("string"),
	ObjectNameFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CollectionType: pulumi.String("string"),
	Overrides: loganalytics.LogAnalyticsObjectCollectionRuleOverrideArray{
		&loganalytics.LogAnalyticsObjectCollectionRuleOverrideArgs{
			MatchType:     pulumi.String("string"),
			MatchValue:    pulumi.String("string"),
			PropertyName:  pulumi.String("string"),
			PropertyValue: pulumi.String("string"),
		},
	},
	PollSince: pulumi.String("string"),
	PollTill:  pulumi.String("string"),
	Timezone:  pulumi.String("string"),
})

var logAnalyticsObjectCollectionRuleResource = new LogAnalyticsObjectCollectionRule("logAnalyticsObjectCollectionRuleResource", LogAnalyticsObjectCollectionRuleArgs.builder()
    .logGroupId("string")
    .osNamespace("string")
    .compartmentId("string")
    .osBucketName("string")
    .namespace("string")
    .logSourceName("string")
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .isForceHistoricCollection(false)
    .charEncoding("string")
    .logSet("string")
    .logSetExtRegex("string")
    .logSetKey("string")
    .entityId("string")
    .logType("string")
    .isEnabled(false)
    .description("string")
    .objectNameFilters("string")
    .definedTags(Map.of("string", "string"))
    .collectionType("string")
    .overrides(LogAnalyticsObjectCollectionRuleOverrideArgs.builder()
        .matchType("string")
        .matchValue("string")
        .propertyName("string")
        .propertyValue("string")
        .build())
    .pollSince("string")
    .pollTill("string")
    .timezone("string")
    .build());

log_analytics_object_collection_rule_resource = oci.log_analytics.LogAnalyticsObjectCollectionRule("logAnalyticsObjectCollectionRuleResource",
    log_group_id="string",
    os_namespace="string",
    compartment_id="string",
    os_bucket_name="string",
    namespace="string",
    log_source_name="string",
    freeform_tags={
        "string": "string",
    },
    name="string",
    is_force_historic_collection=False,
    char_encoding="string",
    log_set="string",
    log_set_ext_regex="string",
    log_set_key="string",
    entity_id="string",
    log_type="string",
    is_enabled=False,
    description="string",
    object_name_filters=["string"],
    defined_tags={
        "string": "string",
    },
    collection_type="string",
    overrides=[{
        "match_type": "string",
        "match_value": "string",
        "property_name": "string",
        "property_value": "string",
    }],
    poll_since="string",
    poll_till="string",
    timezone="string")

const logAnalyticsObjectCollectionRuleResource = new oci.loganalytics.LogAnalyticsObjectCollectionRule("logAnalyticsObjectCollectionRuleResource", {
    logGroupId: "string",
    osNamespace: "string",
    compartmentId: "string",
    osBucketName: "string",
    namespace: "string",
    logSourceName: "string",
    freeformTags: {
        string: "string",
    },
    name: "string",
    isForceHistoricCollection: false,
    charEncoding: "string",
    logSet: "string",
    logSetExtRegex: "string",
    logSetKey: "string",
    entityId: "string",
    logType: "string",
    isEnabled: false,
    description: "string",
    objectNameFilters: ["string"],
    definedTags: {
        string: "string",
    },
    collectionType: "string",
    overrides: [{
        matchType: "string",
        matchValue: "string",
        propertyName: "string",
        propertyValue: "string",
    }],
    pollSince: "string",
    pollTill: "string",
    timezone: "string",
});

type: oci:LogAnalytics:LogAnalyticsObjectCollectionRule
properties:
    charEncoding: string
    collectionType: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    entityId: string
    freeformTags:
        string: string
    isEnabled: false
    isForceHistoricCollection: false
    logGroupId: string
    logSet: string
    logSetExtRegex: string
    logSetKey: string
    logSourceName: string
    logType: string
    name: string
    namespace: string
    objectNameFilters:
        - string
    osBucketName: string
    osNamespace: string
    overrides:
        - matchType: string
          matchValue: string
          propertyName: string
          propertyValue: string
    pollSince: string
    pollTill: string
    timezone: string

LogAnalyticsObjectCollectionRule 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 LogAnalyticsObjectCollectionRule resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

LogGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

LogSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

Namespace string

The Logging Analytics namespace used for the request.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

CharEncoding string

(Updatable) An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

FreeformTags Dictionary<string, string>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled bool

(Updatable) Whether or not this rule is currently enabled.

IsForceHistoricCollection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

LogSet string

(Updatable) The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.

LogSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

LogSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

LogType string

Type of files/objects in this object collection rule.

Name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

ObjectNameFilters List<string>

(Updatable) When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

Overrides List<LogAnalyticsObjectCollectionRuleOverride>

(Updatable) The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are "contains".

PollSince string

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

PollTill string

The newest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.

Timezone string

(Updatable) Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

LogGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

LogSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

Namespace string

The Logging Analytics namespace used for the request.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

CharEncoding string

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

FreeformTags map[string]string

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled bool

(Updatable) Whether or not this rule is currently enabled.

IsForceHistoricCollection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

LogSet string

LogSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

LogSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

LogType string

Type of files/objects in this object collection rule.

Name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

ObjectNameFilters []string

Overrides []LogAnalyticsObjectCollectionRuleOverrideArgs

PollSince string

PollTill string

Timezone string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The OCID of the compartment to which this rule belongs.

logGroupId String

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSourceName String

(Updatable) Name of the Logging Analytics Source to use for the processing.

namespace String

The Logging Analytics namespace used for the request.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

charEncoding String

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags Map<String,String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled Boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection Boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

logSet String

logSetExtRegex String

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey String

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logType String

Type of files/objects in this object collection rule.

name String

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

objectNameFilters List<String>

overrides List<ObjectCollectionRuleOverride>

pollSince String

pollTill String

timezone String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

logGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

namespace string

The Logging Analytics namespace used for the request.

osBucketName string

Name of the Object Storage bucket.

osNamespace string

Object Storage namespace.

charEncoding string

collectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags {[key: string]: string}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

logSet string

logSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logType string

Type of files/objects in this object collection rule.

name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

objectNameFilters string[]

overrides LogAnalyticsObjectCollectionRuleOverride[]

pollSince string

pollTill string

timezone string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id str

(Updatable) The OCID of the compartment to which this rule belongs.

log_group_id str

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

log_source_name str

(Updatable) Name of the Logging Analytics Source to use for the processing.

namespace str

The Logging Analytics namespace used for the request.

os_bucket_name str

Name of the Object Storage bucket.

os_namespace str

Object Storage namespace.

char_encoding str

collection_type str

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entity_id str

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeform_tags Mapping[str, str]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

is_enabled bool

(Updatable) Whether or not this rule is currently enabled.

is_force_historic_collection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

log_set str

log_set_ext_regex str

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

log_set_key str

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

log_type str

Type of files/objects in this object collection rule.

name str

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

object_name_filters Sequence[str]

overrides Sequence[LogAnalyticsObjectCollectionRuleOverrideArgs]

poll_since str

poll_till str

timezone str

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The OCID of the compartment to which this rule belongs.

logGroupId String

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSourceName String

(Updatable) Name of the Logging Analytics Source to use for the processing.

namespace String

The Logging Analytics namespace used for the request.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

charEncoding String

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags Map<String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled Boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection Boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

logSet String

logSetExtRegex String

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey String

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logType String

Type of files/objects in this object collection rule.

name String

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

objectNameFilters List<String>

overrides List<Property Map>

pollSince String

pollTill String

timezone String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
LifecycleDetails string: A detailed status of the life cycle state.
State string: The current state of the rule.
TimeCreated string: The time when this rule was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time when this rule was last updated. An RFC3339 formatted datetime string.

Id string: The provider-assigned unique ID for this managed resource.
LifecycleDetails string: A detailed status of the life cycle state.
State string: The current state of the rule.
TimeCreated string: The time when this rule was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time when this rule was last updated. An RFC3339 formatted datetime string.

id String: The provider-assigned unique ID for this managed resource.
lifecycleDetails String: A detailed status of the life cycle state.
state String: The current state of the rule.
timeCreated String: The time when this rule was created. An RFC3339 formatted datetime string.
timeUpdated String: The time when this rule was last updated. An RFC3339 formatted datetime string.

id string: The provider-assigned unique ID for this managed resource.
lifecycleDetails string: A detailed status of the life cycle state.
state string: The current state of the rule.
timeCreated string: The time when this rule was created. An RFC3339 formatted datetime string.
timeUpdated string: The time when this rule was last updated. An RFC3339 formatted datetime string.

id str: The provider-assigned unique ID for this managed resource.
lifecycle_details str: A detailed status of the life cycle state.
state str: The current state of the rule.
time_created str: The time when this rule was created. An RFC3339 formatted datetime string.
time_updated str: The time when this rule was last updated. An RFC3339 formatted datetime string.

id String: The provider-assigned unique ID for this managed resource.
lifecycleDetails String: A detailed status of the life cycle state.
state String: The current state of the rule.
timeCreated String: The time when this rule was created. An RFC3339 formatted datetime string.
timeUpdated String: The time when this rule was last updated. An RFC3339 formatted datetime string.

Look up Existing LogAnalyticsObjectCollectionRule Resource

Get an existing LogAnalyticsObjectCollectionRule 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?: LogAnalyticsObjectCollectionRuleState, opts?: CustomResourceOptions): LogAnalyticsObjectCollectionRule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        char_encoding: Optional[str] = None,
        collection_type: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        entity_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_enabled: Optional[bool] = None,
        is_force_historic_collection: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        log_group_id: Optional[str] = None,
        log_set: Optional[str] = None,
        log_set_ext_regex: Optional[str] = None,
        log_set_key: Optional[str] = None,
        log_source_name: Optional[str] = None,
        log_type: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        object_name_filters: Optional[Sequence[str]] = None,
        os_bucket_name: Optional[str] = None,
        os_namespace: Optional[str] = None,
        overrides: Optional[Sequence[LogAnalyticsObjectCollectionRuleOverrideArgs]] = None,
        poll_since: Optional[str] = None,
        poll_till: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timezone: Optional[str] = None) -> LogAnalyticsObjectCollectionRule

func GetLogAnalyticsObjectCollectionRule(ctx *Context, name string, id IDInput, state *LogAnalyticsObjectCollectionRuleState, opts ...ResourceOption) (*LogAnalyticsObjectCollectionRule, error)

public static LogAnalyticsObjectCollectionRule Get(string name, Input<string> id, LogAnalyticsObjectCollectionRuleState? state, CustomResourceOptions? opts = null)

public static LogAnalyticsObjectCollectionRule get(String name, Output<String> id, LogAnalyticsObjectCollectionRuleState state, CustomResourceOptions options)

resources:  _:    type: oci:LogAnalytics:LogAnalyticsObjectCollectionRule    get:      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.

The following state arguments are supported:

CharEncoding string

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

CompartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

FreeformTags Dictionary<string, string>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled bool

(Updatable) Whether or not this rule is currently enabled.

IsForceHistoricCollection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

LifecycleDetails string

A detailed status of the life cycle state.

LogGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

LogSet string

LogSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

LogSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

LogSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

LogType string

Type of files/objects in this object collection rule.

Name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

Namespace string

The Logging Analytics namespace used for the request.

ObjectNameFilters List<string>

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides List<LogAnalyticsObjectCollectionRuleOverride>

PollSince string

PollTill string

State string

The current state of the rule.

TimeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

Timezone string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CharEncoding string

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

CompartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

FreeformTags map[string]string

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled bool

(Updatable) Whether or not this rule is currently enabled.

IsForceHistoricCollection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

LifecycleDetails string

A detailed status of the life cycle state.

LogGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

LogSet string

LogSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

LogSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

LogSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

LogType string

Type of files/objects in this object collection rule.

Name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

Namespace string

The Logging Analytics namespace used for the request.

ObjectNameFilters []string

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides []LogAnalyticsObjectCollectionRuleOverrideArgs

PollSince string

PollTill string

State string

The current state of the rule.

TimeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

Timezone string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

charEncoding String

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId String

(Updatable) The OCID of the compartment to which this rule belongs.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags Map<String,String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled Boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection Boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

lifecycleDetails String

A detailed status of the life cycle state.

logGroupId String

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSet String

logSetExtRegex String

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey String

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logSourceName String

(Updatable) Name of the Logging Analytics Source to use for the processing.

logType String

Type of files/objects in this object collection rule.

name String

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

namespace String

The Logging Analytics namespace used for the request.

objectNameFilters List<String>

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<ObjectCollectionRuleOverride>

pollSince String

pollTill String

state String

The current state of the rule.

timeCreated String

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when this rule was last updated. An RFC3339 formatted datetime string.

timezone String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

charEncoding string

collectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId string

(Updatable) The OCID of the compartment to which this rule belongs.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId string

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags {[key: string]: string}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

lifecycleDetails string

A detailed status of the life cycle state.

logGroupId string

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSet string

logSetExtRegex string

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey string

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logSourceName string

(Updatable) Name of the Logging Analytics Source to use for the processing.

logType string

Type of files/objects in this object collection rule.

name string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

namespace string

The Logging Analytics namespace used for the request.

objectNameFilters string[]

osBucketName string

Name of the Object Storage bucket.

osNamespace string

Object Storage namespace.

overrides LogAnalyticsObjectCollectionRuleOverride[]

pollSince string

pollTill string

state string

The current state of the rule.

timeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

timezone string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

char_encoding str

collection_type str

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartment_id str

(Updatable) The OCID of the compartment to which this rule belongs.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entity_id str

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeform_tags Mapping[str, str]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

is_enabled bool

(Updatable) Whether or not this rule is currently enabled.

is_force_historic_collection bool

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

lifecycle_details str

A detailed status of the life cycle state.

log_group_id str

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

log_set str

log_set_ext_regex str

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

log_set_key str

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

log_source_name str

(Updatable) Name of the Logging Analytics Source to use for the processing.

log_type str

Type of files/objects in this object collection rule.

name str

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

namespace str

The Logging Analytics namespace used for the request.

object_name_filters Sequence[str]

os_bucket_name str

Name of the Object Storage bucket.

os_namespace str

Object Storage namespace.

overrides Sequence[LogAnalyticsObjectCollectionRuleOverrideArgs]

poll_since str

poll_till str

state str

The current state of the rule.

time_created str

The time when this rule was created. An RFC3339 formatted datetime string.

time_updated str

The time when this rule was last updated. An RFC3339 formatted datetime string.

timezone str

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

charEncoding String

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId String

(Updatable) The OCID of the compartment to which this rule belongs.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

(Updatable) Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

freeformTags Map<String>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isEnabled Boolean

(Updatable) Whether or not this rule is currently enabled.

isForceHistoricCollection Boolean

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

lifecycleDetails String

A detailed status of the life cycle state.

logGroupId String

(Updatable) Logging Analytics Log group OCID to associate the processed logs with.

logSet String

logSetExtRegex String

(Updatable) The regex to be applied against given logSetKey. Regex has to be in string escaped format.

logSetKey String

(Updatable) An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).

logSourceName String

(Updatable) Name of the Logging Analytics Source to use for the processing.

logType String

Type of files/objects in this object collection rule.

name String

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.

namespace String

The Logging Analytics namespace used for the request.

objectNameFilters List<String>

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<Property Map>

pollSince String

pollTill String

state String

The current state of the rule.

timeCreated String

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when this rule was last updated. An RFC3339 formatted datetime string.

timezone String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Supporting Types

LogAnalyticsObjectCollectionRuleOverride, LogAnalyticsObjectCollectionRuleOverrideArgs

MatchType string
MatchValue string
PropertyName string
PropertyValue string

MatchType string
MatchValue string
PropertyName string
PropertyValue string

matchType String
matchValue String
propertyName String
propertyValue String

matchType string
matchValue string
propertyName string
propertyValue string

match_type str
match_value str
property_name str
property_value str

matchType String
matchValue String
propertyName String
propertyValue String

Import

LogAnalyticsObjectCollectionRules can be imported using the id, e.g.

$ pulumi import oci:LogAnalytics/logAnalyticsObjectCollectionRule:LogAnalyticsObjectCollectionRule test_log_analytics_object_collection_rule "namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.LogAnalytics.LogAnalyticsObjectCollectionRule

On this page

On this page

Example Usage

Create LogAnalyticsObjectCollectionRule Resource

Constructor syntax

Parameters

Constructor example

LogAnalyticsObjectCollectionRule Resource Properties

Inputs

Outputs

Look up Existing LogAnalyticsObjectCollectionRule Resource

Supporting Types

LogAnalyticsObjectCollectionRuleOverride, LogAnalyticsObjectCollectionRuleOverrideArgs

Import

Package Details

On this page

On this page