import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Namespace Scheduled Task resource in Oracle Cloud Infrastructure Log Analytics service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/logan-api-spec/latest/NamespaceScheduledTask * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/log_analytics * * Schedule a task as specified and return task info. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testNamespaceScheduledTask = new oci.loganalytics.NamespaceScheduledTask("test_namespace_scheduled_task", { * compartmentId: compartmentId, * kind: namespaceScheduledTaskKind, * namespace: namespaceScheduledTaskNamespace, * action: { * type: namespaceScheduledTaskActionType, * compartmentIdInSubtree: namespaceScheduledTaskActionCompartmentIdInSubtree === "true", * dataType: namespaceScheduledTaskActionDataType, * metricExtraction: { * compartmentId: compartmentId, * metricCollections: [{ * dimensions: [{ * dimensionName: namespaceScheduledTaskActionMetricExtractionMetricCollectionsDimensionsDimensionName, * queryFieldName: namespaceScheduledTaskActionMetricExtractionMetricCollectionsDimensionsQueryFieldName, * }], * metricName: testMetric.name, * metricQueryFieldName: namespaceScheduledTaskActionMetricExtractionMetricCollectionsMetricQueryFieldName, * queryTableName: testTable.name, * }], * metricName: testMetric.name, * namespace: namespaceScheduledTaskActionMetricExtractionNamespace, * resourceGroup: namespaceScheduledTaskActionMetricExtractionResourceGroup, * }, * purgeCompartmentId: testCompartment.id, * purgeDuration: namespaceScheduledTaskActionPurgeDuration, * queryString: namespaceScheduledTaskActionQueryString, * savedSearchId: testSavedSearch.id, * templateDetails: { * templateId: testTemplate.id, * templateParams: [{ * keyField: namespaceScheduledTaskActionTemplateDetailsTemplateParamsKeyField, * valueField: namespaceScheduledTaskActionTemplateDetailsTemplateParamsValueField, * }], * }, * }, * definedTags: { * "foo-namespace.bar-key": "value", * }, * description: namespaceScheduledTaskDescription, * displayName: namespaceScheduledTaskDisplayName, * freeformTags: { * "bar-key": "value", * }, * savedSearchId: testSavedSearch.id, * schedules: { * type: namespaceScheduledTaskSchedulesType, * expression: namespaceScheduledTaskSchedulesExpression, * misfirePolicy: namespaceScheduledTaskSchedulesMisfirePolicy, * queryOffsetSecs: namespaceScheduledTaskSchedulesQueryOffsetSecs, * recurringInterval: namespaceScheduledTaskSchedulesRecurringInterval, * repeatCount: namespaceScheduledTaskSchedulesRepeatCount, * timeEnd: namespaceScheduledTaskSchedulesTimeEnd, * timeZone: namespaceScheduledTaskSchedulesTimeZone, * }, * taskType: namespaceScheduledTaskTaskType, * }); * ``` * * ## Schedules * * There are parameters which require a specific constant value to be supplied. * * ### misfirePolicy * * #### 'RETRY_INDEFINITELY' * A constant which can be used with the misfirePolicy property of a Schedule. This constant has a value of “RETRY_INDEFINITELY” * * #### 'RETRY_ONCE' * A constant which can be used with the misfirePolicy property of a Schedule. This constant has a value of “RETRY_ONCE” * * #### 'SKIP' * A constant which can be used with the misfirePolicy property of a Schedule. This constant has a value of “SKIP” * * ### type * * #### 'AUTO' * A constant which can be used with the type property of a Schedule. This constant has a value of “AUTO” * * #### 'CRON' * A constant which can be used with the type property of a Schedule. This constant has a value of “CRON” * * #### 'FIXED_FREQUENCY' * A constant which can be used with the type property of a Schedule. This constant has a value of “FIXED_FREQUENCY” * * ## Import * * NamespaceScheduledTasks can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:LogAnalytics/namespaceScheduledTask:NamespaceScheduledTask test_namespace_scheduled_task "namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}" * ``` */ export declare class NamespaceScheduledTask extends pulumi.CustomResource { /** * Get an existing NamespaceScheduledTask resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: NamespaceScheduledTaskState, opts?: pulumi.CustomResourceOptions): NamespaceScheduledTask; /** * Returns true if the given object is an instance of NamespaceScheduledTask. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is NamespaceScheduledTask; /** * Action for scheduled task. */ readonly action: pulumi.Output; /** * (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Description for this resource. */ readonly description: pulumi.Output; /** * (Updatable) A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. */ readonly displayName: pulumi.Output; /** * (Updatable) 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: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Discriminator. */ readonly kind: pulumi.Output; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ readonly namespace: pulumi.Output; /** * Number of execution occurrences. */ readonly numOccurrences: pulumi.Output; /** * The ManagementSavedSearch id [OCID] to be accelerated. */ readonly savedSearchId: pulumi.Output; readonly scheduledTaskId: pulumi.Output; /** * (Updatable) Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks. */ readonly schedules: pulumi.Output; /** * The current state of the scheduled task. */ readonly state: pulumi.Output; /** * Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND - LIMIT_EXCEEDED */ readonly taskStatus: pulumi.Output; /** * Task type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly taskType: pulumi.Output; /** * The date and time the scheduled task was created, in the format defined by RFC3339. */ readonly timeCreated: pulumi.Output; /** * The date and time the scheduled task was last updated, in the format defined by RFC3339. */ readonly timeUpdated: pulumi.Output; /** * most recent Work Request Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request. */ readonly workRequestId: pulumi.Output; /** * Create a NamespaceScheduledTask resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: NamespaceScheduledTaskArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering NamespaceScheduledTask resources. */ export interface NamespaceScheduledTaskState { /** * Action for scheduled task. */ action?: pulumi.Input; /** * (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Description for this resource. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Discriminator. */ kind?: pulumi.Input; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace?: pulumi.Input; /** * Number of execution occurrences. */ numOccurrences?: pulumi.Input; /** * The ManagementSavedSearch id [OCID] to be accelerated. */ savedSearchId?: pulumi.Input; scheduledTaskId?: pulumi.Input; /** * (Updatable) Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks. */ schedules?: pulumi.Input; /** * The current state of the scheduled task. */ state?: pulumi.Input; /** * Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND - LIMIT_EXCEEDED */ taskStatus?: pulumi.Input; /** * Task type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ taskType?: pulumi.Input; /** * The date and time the scheduled task was created, in the format defined by RFC3339. */ timeCreated?: pulumi.Input; /** * The date and time the scheduled task was last updated, in the format defined by RFC3339. */ timeUpdated?: pulumi.Input; /** * most recent Work Request Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request. */ workRequestId?: pulumi.Input; } /** * The set of arguments for constructing a NamespaceScheduledTask resource. */ export interface NamespaceScheduledTaskArgs { /** * Action for scheduled task. */ action: pulumi.Input; /** * (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Description for this resource. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Discriminator. */ kind: pulumi.Input; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: pulumi.Input; /** * The ManagementSavedSearch id [OCID] to be accelerated. */ savedSearchId?: pulumi.Input; /** * (Updatable) Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks. */ schedules: pulumi.Input; /** * Task type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ taskType: pulumi.Input; } //# sourceMappingURL=namespaceScheduledTask.d.ts.map