1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LogAnalytics
  5. LogAnalyticsObjectCollectionRule
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.LogAnalytics.LogAnalyticsObjectCollectionRule

This resource provides the Log Analytics Object Collection Rule resource in Oracle Cloud Infrastructure Log Analytics service.

Create a configuration to collect logs from object storage bucket.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsObjectCollectionRule = new Oci.LogAnalytics.LogAnalyticsObjectCollectionRule("testLogAnalyticsObjectCollectionRule", new()
    {
        CompartmentId = @var.Compartment_id,
        LogGroupId = oci_logging_log_group.Test_log_group.Id,
        LogSourceName = @var.Log_analytics_object_collection_rule_log_source_name,
        Namespace = @var.Log_analytics_object_collection_rule_namespace,
        OsBucketName = oci_objectstorage_bucket.Test_bucket.Name,
        OsNamespace = @var.Log_analytics_object_collection_rule_os_namespace,
        CharEncoding = @var.Log_analytics_object_collection_rule_char_encoding,
        CollectionType = @var.Log_analytics_object_collection_rule_collection_type,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = @var.Log_analytics_object_collection_rule_description,
        EntityId = oci_log_analytics_entity.Test_entity.Id,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        LogSet = @var.Log_analytics_object_collection_rule_log_set,
        LogSetExtRegex = @var.Log_analytics_object_collection_rule_log_set_ext_regex,
        LogSetKey = @var.Log_analytics_object_collection_rule_log_set_key,
        ObjectNameFilters = @var.Log_analytics_object_collection_rule_object_name_filters,
        Overrides = @var.Log_analytics_object_collection_rule_overrides,
        PollSince = @var.Log_analytics_object_collection_rule_poll_since,
        PollTill = @var.Log_analytics_object_collection_rule_poll_till,
        Timezone = @var.Log_analytics_object_collection_rule_timezone,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LogAnalytics.NewLogAnalyticsObjectCollectionRule(ctx, "testLogAnalyticsObjectCollectionRule", &LogAnalytics.LogAnalyticsObjectCollectionRuleArgs{
			CompartmentId:  pulumi.Any(_var.Compartment_id),
			LogGroupId:     pulumi.Any(oci_logging_log_group.Test_log_group.Id),
			LogSourceName:  pulumi.Any(_var.Log_analytics_object_collection_rule_log_source_name),
			Namespace:      pulumi.Any(_var.Log_analytics_object_collection_rule_namespace),
			OsBucketName:   pulumi.Any(oci_objectstorage_bucket.Test_bucket.Name),
			OsNamespace:    pulumi.Any(_var.Log_analytics_object_collection_rule_os_namespace),
			CharEncoding:   pulumi.Any(_var.Log_analytics_object_collection_rule_char_encoding),
			CollectionType: pulumi.Any(_var.Log_analytics_object_collection_rule_collection_type),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(_var.Log_analytics_object_collection_rule_description),
			EntityId:    pulumi.Any(oci_log_analytics_entity.Test_entity.Id),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			LogSet:            pulumi.Any(_var.Log_analytics_object_collection_rule_log_set),
			LogSetExtRegex:    pulumi.Any(_var.Log_analytics_object_collection_rule_log_set_ext_regex),
			LogSetKey:         pulumi.Any(_var.Log_analytics_object_collection_rule_log_set_key),
			ObjectNameFilters: pulumi.Any(_var.Log_analytics_object_collection_rule_object_name_filters),
			Overrides:         pulumi.Any(_var.Log_analytics_object_collection_rule_overrides),
			PollSince:         pulumi.Any(_var.Log_analytics_object_collection_rule_poll_since),
			PollTill:          pulumi.Any(_var.Log_analytics_object_collection_rule_poll_till),
			Timezone:          pulumi.Any(_var.Log_analytics_object_collection_rule_timezone),
		})
		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.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(var_.compartment_id())
            .logGroupId(oci_logging_log_group.test_log_group().id())
            .logSourceName(var_.log_analytics_object_collection_rule_log_source_name())
            .namespace(var_.log_analytics_object_collection_rule_namespace())
            .osBucketName(oci_objectstorage_bucket.test_bucket().name())
            .osNamespace(var_.log_analytics_object_collection_rule_os_namespace())
            .charEncoding(var_.log_analytics_object_collection_rule_char_encoding())
            .collectionType(var_.log_analytics_object_collection_rule_collection_type())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(var_.log_analytics_object_collection_rule_description())
            .entityId(oci_log_analytics_entity.test_entity().id())
            .freeformTags(Map.of("bar-key", "value"))
            .logSet(var_.log_analytics_object_collection_rule_log_set())
            .logSetExtRegex(var_.log_analytics_object_collection_rule_log_set_ext_regex())
            .logSetKey(var_.log_analytics_object_collection_rule_log_set_key())
            .objectNameFilters(var_.log_analytics_object_collection_rule_object_name_filters())
            .overrides(var_.log_analytics_object_collection_rule_overrides())
            .pollSince(var_.log_analytics_object_collection_rule_poll_since())
            .pollTill(var_.log_analytics_object_collection_rule_poll_till())
            .timezone(var_.log_analytics_object_collection_rule_timezone())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

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

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

const testLogAnalyticsObjectCollectionRule = new oci.loganalytics.LogAnalyticsObjectCollectionRule("testLogAnalyticsObjectCollectionRule", {
    compartmentId: _var.compartment_id,
    logGroupId: oci_logging_log_group.test_log_group.id,
    logSourceName: _var.log_analytics_object_collection_rule_log_source_name,
    namespace: _var.log_analytics_object_collection_rule_namespace,
    osBucketName: oci_objectstorage_bucket.test_bucket.name,
    osNamespace: _var.log_analytics_object_collection_rule_os_namespace,
    charEncoding: _var.log_analytics_object_collection_rule_char_encoding,
    collectionType: _var.log_analytics_object_collection_rule_collection_type,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: _var.log_analytics_object_collection_rule_description,
    entityId: oci_log_analytics_entity.test_entity.id,
    freeformTags: {
        "bar-key": "value",
    },
    logSet: _var.log_analytics_object_collection_rule_log_set,
    logSetExtRegex: _var.log_analytics_object_collection_rule_log_set_ext_regex,
    logSetKey: _var.log_analytics_object_collection_rule_log_set_key,
    objectNameFilters: _var.log_analytics_object_collection_rule_object_name_filters,
    overrides: _var.log_analytics_object_collection_rule_overrides,
    pollSince: _var.log_analytics_object_collection_rule_poll_since,
    pollTill: _var.log_analytics_object_collection_rule_poll_till,
    timezone: _var.log_analytics_object_collection_rule_timezone,
});

resources:
  testLogAnalyticsObjectCollectionRule:
    type: oci:LogAnalytics:LogAnalyticsObjectCollectionRule
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      logGroupId: ${oci_logging_log_group.test_log_group.id}
      logSourceName: ${var.log_analytics_object_collection_rule_log_source_name}
      namespace: ${var.log_analytics_object_collection_rule_namespace}
      osBucketName: ${oci_objectstorage_bucket.test_bucket.name}
      osNamespace: ${var.log_analytics_object_collection_rule_os_namespace}
      #Optional
      charEncoding: ${var.log_analytics_object_collection_rule_char_encoding}
      collectionType: ${var.log_analytics_object_collection_rule_collection_type}
      definedTags:
        foo-namespace.bar-key: value
      description: ${var.log_analytics_object_collection_rule_description}
      entityId: ${oci_log_analytics_entity.test_entity.id}
      freeformTags:
        bar-key: value
      logSet: ${var.log_analytics_object_collection_rule_log_set}
      logSetExtRegex: ${var.log_analytics_object_collection_rule_log_set_ext_regex}
      logSetKey: ${var.log_analytics_object_collection_rule_log_set_key}
      objectNameFilters: ${var.log_analytics_object_collection_rule_object_name_filters}
      overrides: ${var.log_analytics_object_collection_rule_overrides}
      pollSince: ${var.log_analytics_object_collection_rule_poll_since}
      pollTill: ${var.log_analytics_object_collection_rule_poll_till}
      timezone: ${var.log_analytics_object_collection_rule_timezone}

Create LogAnalyticsObjectCollectionRule Resource

new LogAnalyticsObjectCollectionRule(name: string, args: LogAnalyticsObjectCollectionRuleArgs, opts?: CustomResourceOptions);
@overload
def LogAnalyticsObjectCollectionRule(resource_name: 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, Any]] = None,
                                     description: Optional[str] = None,
                                     entity_id: Optional[str] = None,
                                     freeform_tags: Optional[Mapping[str, Any]] = 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,
                                     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[_loganalytics.LogAnalyticsObjectCollectionRuleOverrideArgs]] = None,
                                     poll_since: Optional[str] = None,
                                     poll_till: Optional[str] = None,
                                     timezone: Optional[str] = None)
@overload
def LogAnalyticsObjectCollectionRule(resource_name: str,
                                     args: LogAnalyticsObjectCollectionRuleArgs,
                                     opts: Optional[ResourceOptions] = 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.
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.

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

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, object>

(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, object>

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

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/).

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<LogAnalyticsObjectCollectionRuleOverrideArgs>

(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.

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 map[string]interface{}

(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]interface{}

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

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/).

Name string

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

ObjectNameFilters []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 []LogAnalyticsObjectCollectionRuleOverrideArgs

(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.

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 Map<String,Object>

(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,Object>

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

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/).

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<ObjectCollectionRuleOverrideArgs>

(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.

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 {[key: string]: any}

(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]: any}

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

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/).

name string

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

objectNameFilters 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 LogAnalyticsObjectCollectionRuleOverrideArgs[]

(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.

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

(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.

collection_type str

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

defined_tags Mapping[str, Any]

(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, Any]

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

log_set str

(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.

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/).

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]

(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 LogAnalyticsObjectCollectionRuleOverrideArgs]

(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".

poll_since str

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.

poll_till str

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 str

(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.

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 Map<Any>

(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<Any>

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

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/).

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<Property Map>

(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.

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, Any]] = None,
        description: Optional[str] = None,
        entity_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = 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,
        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[_loganalytics.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)
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:
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

CompartmentId string

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

DefinedTags Dictionary<string, object>

(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, object>

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

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

(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/).

LogSourceName string

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

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>

(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.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides List<LogAnalyticsObjectCollectionRuleOverrideArgs>

(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.

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

(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.

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

CompartmentId string

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

DefinedTags map[string]interface{}

(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]interface{}

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

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

(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/).

LogSourceName string

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

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

(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.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides []LogAnalyticsObjectCollectionRuleOverrideArgs

(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.

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

(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.

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

compartmentId String

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

definedTags Map<String,Object>

(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,Object>

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

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

(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/).

logSourceName String

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

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>

(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.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<ObjectCollectionRuleOverrideArgs>

(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.

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

(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.

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

compartmentId string

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

definedTags {[key: string]: any}

(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]: any}

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

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

(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/).

logSourceName string

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

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[]

(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.

osBucketName string

Name of the Object Storage bucket.

osNamespace string

Object Storage namespace.

overrides LogAnalyticsObjectCollectionRuleOverrideArgs[]

(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.

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

(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.

char_encoding str

(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.

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, Any]

(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, Any]

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

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

(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.

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.

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]

(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.

os_bucket_name str

Name of the Object Storage bucket.

os_namespace str

Object Storage namespace.

overrides LogAnalyticsObjectCollectionRuleOverrideArgs]

(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".

poll_since str

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.

poll_till str

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.

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

(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.

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

compartmentId String

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

definedTags Map<Any>

(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<Any>

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

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

(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/).

logSourceName String

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

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>

(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.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<Property Map>

(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.

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

(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.

Supporting Types

LogAnalyticsObjectCollectionRuleOverride

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}"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.