1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LogAnalytics
  5. getLogAnalyticsObjectCollectionRule
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.LogAnalytics.getLogAnalyticsObjectCollectionRule

Explore with Pulumi AI

This data source provides details about a specific Log Analytics Object Collection Rule resource in Oracle Cloud Infrastructure Log Analytics service.

Gets a configured object storage based collection rule by given id

Example Usage

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

const testLogAnalyticsObjectCollectionRule = oci.LogAnalytics.getLogAnalyticsObjectCollectionRule({
    logAnalyticsObjectCollectionRuleId: testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id,
    namespace: logAnalyticsObjectCollectionRuleNamespace,
});
Copy
import pulumi
import pulumi_oci as oci

test_log_analytics_object_collection_rule = oci.LogAnalytics.get_log_analytics_object_collection_rule(log_analytics_object_collection_rule_id=test_log_analytics_object_collection_rule_oci_log_analytics_log_analytics_object_collection_rule["id"],
    namespace=log_analytics_object_collection_rule_namespace)
Copy
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.GetLogAnalyticsObjectCollectionRule(ctx, &loganalytics.GetLogAnalyticsObjectCollectionRuleArgs{
			LogAnalyticsObjectCollectionRuleId: testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.Id,
			Namespace:                          logAnalyticsObjectCollectionRuleNamespace,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsObjectCollectionRule = Oci.LogAnalytics.GetLogAnalyticsObjectCollectionRule.Invoke(new()
    {
        LogAnalyticsObjectCollectionRuleId = testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.Id,
        Namespace = logAnalyticsObjectCollectionRuleNamespace,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LogAnalytics.LogAnalyticsFunctions;
import com.pulumi.oci.LogAnalytics.inputs.GetLogAnalyticsObjectCollectionRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testLogAnalyticsObjectCollectionRule = LogAnalyticsFunctions.getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs.builder()
            .logAnalyticsObjectCollectionRuleId(testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id())
            .namespace(logAnalyticsObjectCollectionRuleNamespace)
            .build());

    }
}
Copy
variables:
  testLogAnalyticsObjectCollectionRule:
    fn::invoke:
      function: oci:LogAnalytics:getLogAnalyticsObjectCollectionRule
      arguments:
        logAnalyticsObjectCollectionRuleId: ${testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id}
        namespace: ${logAnalyticsObjectCollectionRuleNamespace}
Copy

Using getLogAnalyticsObjectCollectionRule

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

function getLogAnalyticsObjectCollectionRule(args: GetLogAnalyticsObjectCollectionRuleArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsObjectCollectionRuleResult>
function getLogAnalyticsObjectCollectionRuleOutput(args: GetLogAnalyticsObjectCollectionRuleOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsObjectCollectionRuleResult>
Copy
def get_log_analytics_object_collection_rule(log_analytics_object_collection_rule_id: Optional[str] = None,
                                             namespace: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsObjectCollectionRuleResult
def get_log_analytics_object_collection_rule_output(log_analytics_object_collection_rule_id: Optional[pulumi.Input[str]] = None,
                                             namespace: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsObjectCollectionRuleResult]
Copy
func GetLogAnalyticsObjectCollectionRule(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleArgs, opts ...InvokeOption) (*GetLogAnalyticsObjectCollectionRuleResult, error)
func GetLogAnalyticsObjectCollectionRuleOutput(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleOutputArgs, opts ...InvokeOption) GetLogAnalyticsObjectCollectionRuleResultOutput
Copy

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

public static class GetLogAnalyticsObjectCollectionRule 
{
    public static Task<GetLogAnalyticsObjectCollectionRuleResult> InvokeAsync(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetLogAnalyticsObjectCollectionRuleResult> Invoke(GetLogAnalyticsObjectCollectionRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLogAnalyticsObjectCollectionRuleResult> getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions options)
public static Output<GetLogAnalyticsObjectCollectionRuleResult> getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:LogAnalytics/getLogAnalyticsObjectCollectionRule:getLogAnalyticsObjectCollectionRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LogAnalyticsObjectCollectionRuleId This property is required. string
The Logging Analytics Object Collection Rule OCID
Namespace This property is required. string
The Logging Analytics namespace used for the request.
LogAnalyticsObjectCollectionRuleId This property is required. string
The Logging Analytics Object Collection Rule OCID
Namespace This property is required. string
The Logging Analytics namespace used for the request.
logAnalyticsObjectCollectionRuleId This property is required. String
The Logging Analytics Object Collection Rule OCID
namespace This property is required. String
The Logging Analytics namespace used for the request.
logAnalyticsObjectCollectionRuleId This property is required. string
The Logging Analytics Object Collection Rule OCID
namespace This property is required. string
The Logging Analytics namespace used for the request.
log_analytics_object_collection_rule_id This property is required. str
The Logging Analytics Object Collection Rule OCID
namespace This property is required. str
The Logging Analytics namespace used for the request.
logAnalyticsObjectCollectionRuleId This property is required. String
The Logging Analytics Object Collection Rule OCID
namespace This property is required. String
The Logging Analytics namespace used for the request.

getLogAnalyticsObjectCollectionRule Result

The following output properties are available:

CharEncoding string
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
The OCID of the compartment to which this rule belongs.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
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
Logging Analytics entity OCID to associate the processed logs with.
FreeformTags Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
The OCID of this rule.
IsEnabled bool
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.
LogAnalyticsObjectCollectionRuleId string
LogGroupId string
Logging Analytics Log group OCID to associate the processed logs with.
LogSet string
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
LogSetKey string
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
Namespace string
ObjectNameFilters List<string>
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<GetLogAnalyticsObjectCollectionRuleOverride>
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
PollTill string
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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
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
The OCID of the compartment to which this rule belongs.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
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
Logging Analytics entity OCID to associate the processed logs with.
FreeformTags map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
The OCID of this rule.
IsEnabled bool
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.
LogAnalyticsObjectCollectionRuleId string
LogGroupId string
Logging Analytics Log group OCID to associate the processed logs with.
LogSet string
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
LogSetKey string
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
Namespace string
ObjectNameFilters []string
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 []GetLogAnalyticsObjectCollectionRuleOverride
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
PollTill string
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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
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
The OCID of the compartment to which this rule belongs.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
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
Logging Analytics entity OCID to associate the processed logs with.
freeformTags Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
The OCID of this rule.
isEnabled Boolean
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.
logAnalyticsObjectCollectionRuleId String
logGroupId String
Logging Analytics Log group OCID to associate the processed logs with.
logSet String
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
logSetKey String
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
namespace String
objectNameFilters List<String>
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<GetObjectCollectionRuleOverride>
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
pollTill String
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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
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
The OCID of the compartment to which this rule belongs.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string
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
Logging Analytics entity OCID to associate the processed logs with.
freeformTags {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string
The OCID of this rule.
isEnabled boolean
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.
logAnalyticsObjectCollectionRuleId string
logGroupId string
Logging Analytics Log group OCID to associate the processed logs with.
logSet string
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
logSetKey string
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
namespace string
objectNameFilters string[]
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 GetLogAnalyticsObjectCollectionRuleOverride[]
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
pollTill string
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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
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
The OCID of the compartment to which this rule belongs.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str
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
Logging Analytics entity OCID to associate the processed logs with.
freeform_tags Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str
The OCID of this rule.
is_enabled bool
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_analytics_object_collection_rule_id str
log_group_id str
Logging Analytics Log group OCID to associate the processed logs with.
log_set str
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
log_set_key str
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
namespace str
object_name_filters Sequence[str]
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 Sequence[loganalytics.GetLogAnalyticsObjectCollectionRuleOverride]
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
poll_till str
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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
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
The OCID of the compartment to which this rule belongs.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
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
Logging Analytics entity OCID to associate the processed logs with.
freeformTags Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
The OCID of this rule.
isEnabled Boolean
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.
logAnalyticsObjectCollectionRuleId String
logGroupId String
Logging Analytics Log group OCID to associate the processed logs with.
logSet String
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
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
logSetKey String
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
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 to the rule. The name must be unique, within the tenancy, and cannot be changed.
namespace String
objectNameFilters List<String>
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>
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. 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. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
pollTill String
The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is 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
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

GetLogAnalyticsObjectCollectionRuleOverride

MatchType This property is required. string
MatchValue This property is required. string
PropertyName This property is required. string
PropertyValue This property is required. string
MatchType This property is required. string
MatchValue This property is required. string
PropertyName This property is required. string
PropertyValue This property is required. string
matchType This property is required. String
matchValue This property is required. String
propertyName This property is required. String
propertyValue This property is required. String
matchType This property is required. string
matchValue This property is required. string
propertyName This property is required. string
propertyValue This property is required. string
match_type This property is required. str
match_value This property is required. str
property_name This property is required. str
property_value This property is required. str
matchType This property is required. String
matchValue This property is required. String
propertyName This property is required. String
propertyValue This property is required. String

Package Details

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