import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Schedule resource in Oracle Cloud Infrastructure Metering Computation service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/usage/latest/Schedule * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/metering_computation * * Returns the created schedule. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testSchedule = new oci.meteringcomputation.Schedule("test_schedule", { * compartmentId: compartmentId, * name: scheduleName, * resultLocation: { * bucket: scheduleResultLocationBucket, * locationType: scheduleResultLocationLocationType, * namespace: scheduleResultLocationNamespace, * region: scheduleResultLocationRegion, * }, * scheduleRecurrences: scheduleScheduleRecurrences, * timeScheduled: scheduleTimeScheduled, * definedTags: { * "foo-namespace.bar-key": "value", * }, * description: scheduleDescription, * freeformTags: { * "bar-key": "value", * }, * outputFileFormat: scheduleOutputFileFormat, * queryProperties: { * dateRange: { * dateRangeType: scheduleQueryPropertiesDateRangeDateRangeType, * dynamicDateRangeType: scheduleQueryPropertiesDateRangeDynamicDateRangeType, * timeUsageEnded: scheduleQueryPropertiesDateRangeTimeUsageEnded, * timeUsageStarted: scheduleQueryPropertiesDateRangeTimeUsageStarted, * }, * granularity: scheduleQueryPropertiesGranularity, * compartmentDepth: scheduleQueryPropertiesCompartmentDepth, * filter: scheduleQueryPropertiesFilter, * groupBies: scheduleQueryPropertiesGroupBy, * groupByTags: [{ * key: scheduleQueryPropertiesGroupByTagKey, * namespace: scheduleQueryPropertiesGroupByTagNamespace, * value: scheduleQueryPropertiesGroupByTagValue, * }], * isAggregateByTime: scheduleQueryPropertiesIsAggregateByTime === "true", * queryType: scheduleQueryPropertiesQueryType, * }, * savedReportId: testReport.id, * }); * ``` * * ## Import * * Schedules can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:MeteringComputation/schedule:Schedule test_schedule "id" * ``` */ export declare class Schedule extends pulumi.CustomResource { /** * Get an existing Schedule 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?: ScheduleState, opts?: pulumi.CustomResourceOptions): Schedule; /** * Returns true if the given object is an instance of Schedule. 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 Schedule; /** * The customer tenancy. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The description of the schedule. */ readonly description: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * The unique name of the user-created schedule. */ readonly name: pulumi.Output; /** * (Updatable) Specifies the supported output file format. */ readonly outputFileFormat: pulumi.Output; /** * The query properties. */ readonly queryProperties: pulumi.Output; /** * (Updatable) The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics. */ readonly resultLocation: pulumi.Output; /** * The saved report ID which can also be used to generate a query. */ readonly savedReportId: pulumi.Output; /** * Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. */ readonly scheduleRecurrences: pulumi.Output; /** * The schedule lifecycle state. */ readonly state: pulumi.Output; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the schedule was created. */ readonly timeCreated: pulumi.Output; /** * The date and time of the next job execution. */ readonly timeNextRun: pulumi.Output; /** * The date and time of the first time job execution. * * ** 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 timeScheduled: pulumi.Output; /** * Create a Schedule 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: ScheduleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Schedule resources. */ export interface ScheduleState { /** * The customer tenancy. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the schedule. */ description?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The unique name of the user-created schedule. */ name?: pulumi.Input; /** * (Updatable) Specifies the supported output file format. */ outputFileFormat?: pulumi.Input; /** * The query properties. */ queryProperties?: pulumi.Input; /** * (Updatable) The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics. */ resultLocation?: pulumi.Input; /** * The saved report ID which can also be used to generate a query. */ savedReportId?: pulumi.Input; /** * Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. */ scheduleRecurrences?: pulumi.Input; /** * The schedule lifecycle state. */ state?: pulumi.Input; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the schedule was created. */ timeCreated?: pulumi.Input; /** * The date and time of the next job execution. */ timeNextRun?: pulumi.Input; /** * The date and time of the first time job execution. * * ** 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 */ timeScheduled?: pulumi.Input; } /** * The set of arguments for constructing a Schedule resource. */ export interface ScheduleArgs { /** * The customer tenancy. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the schedule. */ description?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The unique name of the user-created schedule. */ name?: pulumi.Input; /** * (Updatable) Specifies the supported output file format. */ outputFileFormat?: pulumi.Input; /** * The query properties. */ queryProperties?: pulumi.Input; /** * (Updatable) The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics. */ resultLocation: pulumi.Input; /** * The saved report ID which can also be used to generate a query. */ savedReportId?: pulumi.Input; /** * Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. */ scheduleRecurrences: pulumi.Input; /** * The date and time of the first time job execution. * * ** 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 */ timeScheduled: pulumi.Input; } //# sourceMappingURL=schedule.d.ts.map