import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testLogAnalyticsObjectCollectionRule = oci.loganalytics.getLogAnalyticsObjectCollectionRule({ * logAnalyticsObjectCollectionRuleId: testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id, * namespace: logAnalyticsObjectCollectionRuleNamespace, * }); * ``` */ export declare function getLogAnalyticsObjectCollectionRule(args: GetLogAnalyticsObjectCollectionRuleArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getLogAnalyticsObjectCollectionRule. */ export interface GetLogAnalyticsObjectCollectionRuleArgs { /** * The Log Analytics Object Collection Rule [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ logAnalyticsObjectCollectionRuleId: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; } /** * A collection of values returned by getLogAnalyticsObjectCollectionRule. */ export interface GetLogAnalyticsObjectCollectionRuleResult { /** * 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. */ readonly charEncoding: string; /** * The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE */ readonly collectionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. */ readonly compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: { [key: string]: 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. */ readonly description: string; /** * Log Analytics entity OCID to associate the processed logs with. */ readonly entityId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ readonly id: string; /** * Whether or not this rule is currently enabled. */ readonly isEnabled: boolean; /** * Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule */ readonly isForceHistoricCollection: boolean; /** * Last Collected Object for the rule */ readonly lastCollectedObject: string; /** * A detailed status of the life cycle state. */ readonly lifecycleDetails: string; readonly logAnalyticsObjectCollectionRuleId: string; /** * Log Analytics Log group OCID to associate the processed logs with. */ readonly logGroupId: 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. */ readonly logSet: string; /** * The regex to be applied against given logSetKey. Regex has to be in string escaped format. */ readonly logSetExtRegex: 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/). */ readonly logSetKey: string; /** * Name of the Log Analytics Source to use for the processing. */ readonly logSourceName: string; /** * Type of files/objects in this object collection rule. */ readonly logType: string; /** * A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed. */ readonly name: string; readonly namespace: 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](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm). */ readonly objectNameFilters: string[]; /** * Name of the Object Storage bucket. */ readonly osBucketName: string; /** * Object Storage namespace. */ readonly osNamespace: string; /** * 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". */ readonly overrides: outputs.LogAnalytics.GetLogAnalyticsObjectCollectionRuleOverride[]; /** * 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. */ readonly pollSince: 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. */ readonly pollTill: string; /** * The current state of the rule. */ readonly state: string; /** * The time from which to consume the objects, if streamCursorType is AT_TIME. */ readonly streamCursorTime: string; /** * Cursor type used to fetch messages from stream. When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see [Stream Consumer Groups](https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm). */ readonly streamCursorType: string; /** * A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage. */ readonly streamId: string; /** * The time when this rule was created. An RFC3339 formatted datetime string. */ readonly timeCreated: string; /** * The time when this rule was last updated. An RFC3339 formatted datetime string. */ readonly timeUpdated: 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. */ readonly timezone: string; } /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testLogAnalyticsObjectCollectionRule = oci.loganalytics.getLogAnalyticsObjectCollectionRule({ * logAnalyticsObjectCollectionRuleId: testLogAnalyticsObjectCollectionRuleOciLogAnalyticsLogAnalyticsObjectCollectionRule.id, * namespace: logAnalyticsObjectCollectionRuleNamespace, * }); * ``` */ export declare function getLogAnalyticsObjectCollectionRuleOutput(args: GetLogAnalyticsObjectCollectionRuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getLogAnalyticsObjectCollectionRule. */ export interface GetLogAnalyticsObjectCollectionRuleOutputArgs { /** * The Log Analytics Object Collection Rule [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ logAnalyticsObjectCollectionRuleId: pulumi.Input; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: pulumi.Input; } //# sourceMappingURL=getLogAnalyticsObjectCollectionRule.d.ts.map