Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 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,
});
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)
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
})
}
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,
});
});
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());
}
}
variables:
testLogAnalyticsObjectCollectionRule:
fn::invoke:
Function: oci:LogAnalytics:getLogAnalyticsObjectCollectionRule
Arguments:
logAnalyticsObjectCollectionRuleId: ${testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id}
namespace: ${logAnalyticsObjectCollectionRuleNamespace}
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>
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]
func GetLogAnalyticsObjectCollectionRule(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleArgs, opts ...InvokeOption) (*GetLogAnalyticsObjectCollectionRuleResult, error)
func GetLogAnalyticsObjectCollectionRuleOutput(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleOutputArgs, opts ...InvokeOption) GetLogAnalyticsObjectCollectionRuleResultOutput
> 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)
}
public static CompletableFuture<GetLogAnalyticsObjectCollectionRuleResult> getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:LogAnalytics/getLogAnalyticsObjectCollectionRule:getLogAnalyticsObjectCollectionRule
arguments:
# arguments dictionary
The following arguments are supported:
- Log
Analytics stringObject Collection Rule Id - The Logging Analytics Object Collection Rule OCID
- Namespace string
- The Logging Analytics namespace used for the request.
- Log
Analytics stringObject Collection Rule Id - The Logging Analytics Object Collection Rule OCID
- Namespace string
- The Logging Analytics namespace used for the request.
- log
Analytics StringObject Collection Rule Id - The Logging Analytics Object Collection Rule OCID
- namespace String
- The Logging Analytics namespace used for the request.
- log
Analytics stringObject Collection Rule Id - The Logging Analytics Object Collection Rule OCID
- namespace string
- The Logging Analytics namespace used for the request.
- log_
analytics_ strobject_ collection_ rule_ id - The Logging Analytics Object Collection Rule OCID
- namespace str
- The Logging Analytics namespace used for the request.
- log
Analytics StringObject Collection Rule Id - The Logging Analytics Object Collection Rule OCID
- namespace String
- The Logging Analytics namespace used for the request.
getLogAnalyticsObjectCollectionRule Result
The following output properties are available:
- Char
Encoding 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.
- Collection
Type string - The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE
- Compartment
Id string - The OCID of the compartment to which this rule belongs.
- 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.
- Entity
Id string - Logging Analytics entity OCID to associate the processed logs with.
- 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.
- Is
Enabled bool - Whether or not this rule is currently enabled.
- Is
Force boolHistoric Collection - Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- Lifecycle
Details string - A detailed status of the life cycle state.
- Log
Analytics stringObject Collection Rule Id - Log
Group stringId - Logging Analytics Log group OCID to associate the processed logs with.
- Log
Set 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.
- Log
Set stringExt Regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- Log
Set stringKey - 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 stringName - Name of the Logging Analytics Source to use for the processing.
- Log
Type 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
- Object
Name List<string>Filters - 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 stringName - Name of the Object Storage bucket.
- Os
Namespace string - Object Storage namespace.
- Overrides
List<Get
Log Analytics Object Collection Rule Override> - 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 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.
- Poll
Till 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.
- Time
Created string - The time when this rule was created. An RFC3339 formatted datetime string.
- Time
Updated 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 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.
- Collection
Type string - The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE
- Compartment
Id string - The OCID of the compartment to which this rule belongs.
- 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.
- Entity
Id string - Logging Analytics entity OCID to associate the processed logs with.
- 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.
- Is
Enabled bool - Whether or not this rule is currently enabled.
- Is
Force boolHistoric Collection - Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- Lifecycle
Details string - A detailed status of the life cycle state.
- Log
Analytics stringObject Collection Rule Id - Log
Group stringId - Logging Analytics Log group OCID to associate the processed logs with.
- Log
Set 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.
- Log
Set stringExt Regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- Log
Set stringKey - 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 stringName - Name of the Logging Analytics Source to use for the processing.
- Log
Type 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
- Object
Name []stringFilters - 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 stringName - Name of the Object Storage bucket.
- Os
Namespace string - Object Storage namespace.
- Overrides
[]Get
Log Analytics Object Collection Rule Override - 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 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.
- Poll
Till 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.
- Time
Created string - The time when this rule was created. An RFC3339 formatted datetime string.
- Time
Updated 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 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.
- collection
Type String - The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE
- compartment
Id String - The OCID of the compartment to which this rule belongs.
- 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.
- entity
Id String - Logging Analytics entity OCID to associate the processed logs with.
- 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.
- is
Enabled Boolean - Whether or not this rule is currently enabled.
- is
Force BooleanHistoric Collection - Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycle
Details String - A detailed status of the life cycle state.
- log
Analytics StringObject Collection Rule Id - log
Group StringId - Logging Analytics Log group OCID to associate the processed logs with.
- log
Set 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.
- log
Set StringExt Regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- log
Set StringKey - 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 StringName - Name of the Logging Analytics Source to use for the processing.
- log
Type 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
- object
Name List<String>Filters - 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 StringName - Name of the Object Storage bucket.
- os
Namespace String - Object Storage namespace.
- overrides
List<Get
Object Collection Rule Override> - 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 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.
- poll
Till 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.
- time
Created String - The time when this rule was created. An RFC3339 formatted datetime string.
- time
Updated 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 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.
- collection
Type string - The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE
- compartment
Id string - The OCID of the compartment to which this rule belongs.
- {[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.
- entity
Id string - Logging Analytics entity OCID to associate the processed logs with.
- {[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.
- is
Enabled boolean - Whether or not this rule is currently enabled.
- is
Force booleanHistoric Collection - Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycle
Details string - A detailed status of the life cycle state.
- log
Analytics stringObject Collection Rule Id - log
Group stringId - Logging Analytics Log group OCID to associate the processed logs with.
- log
Set 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.
- log
Set stringExt Regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- log
Set stringKey - 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 stringName - Name of the Logging Analytics Source to use for the processing.
- log
Type 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
- object
Name string[]Filters - 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 stringName - Name of the Object Storage bucket.
- os
Namespace string - Object Storage namespace.
- overrides
Get
Log Analytics Object Collection Rule Override[] - 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 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.
- poll
Till 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.
- time
Created string - The time when this rule was created. An RFC3339 formatted datetime string.
- time
Updated 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.
- 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.
- 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_ boolhistoric_ collection - 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_ strobject_ collection_ rule_ id - log_
group_ strid - 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_ strext_ regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- log_
set_ strkey - 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_ strname - 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_ Sequence[str]filters - 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_ strname - Name of the Object Storage bucket.
- os_
namespace str - Object Storage namespace.
- overrides
Sequence[loganalytics.
Get Log Analytics Object Collection Rule Override] - 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.
- char
Encoding 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.
- collection
Type String - The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE
- compartment
Id String - The OCID of the compartment to which this rule belongs.
- 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.
- entity
Id String - Logging Analytics entity OCID to associate the processed logs with.
- 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.
- is
Enabled Boolean - Whether or not this rule is currently enabled.
- is
Force BooleanHistoric Collection - Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycle
Details String - A detailed status of the life cycle state.
- log
Analytics StringObject Collection Rule Id - log
Group StringId - Logging Analytics Log group OCID to associate the processed logs with.
- log
Set 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.
- log
Set StringExt Regex - The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- log
Set StringKey - 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 StringName - Name of the Logging Analytics Source to use for the processing.
- log
Type 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
- object
Name List<String>Filters - 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 StringName - Name of the Object Storage bucket.
- os
Namespace 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".
- poll
Since 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.
- poll
Till 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.
- time
Created String - The time when this rule was created. An RFC3339 formatted datetime string.
- time
Updated 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
- Match
Type string - Match
Value string - Property
Name string - Property
Value string
- Match
Type string - Match
Value string - Property
Name string - Property
Value string
- match
Type String - match
Value String - property
Name String - property
Value String
- match
Type string - match
Value string - property
Name string - property
Value string
- match_
type str - match_
value str - property_
name str - property_
value str
- match
Type String - match
Value String - property
Name String - property
Value String
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.