import * as pulumi from "@pulumi/pulumi"; /** * Provides a [Sumologic Ingest Budget v2][1]. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as sumologic from "@pulumi/sumologic"; * * const budget = new sumologic.IngestBudgetV2("budget", { * name: "testBudget", * scope: "_sourceCategory=*prod*nginx*", * budgetType: "dailyVolume", * capacityBytes: 30000000000, * description: "For testing purposes", * timezone: "Etc/UTC", * action: "keepCollecting", * resetTime: "00:00", * auditThreshold: 85, * }); * ``` * * ## Import * * Ingest budgets can be imported using the budget ID or name, e.g.: * * hcl * * ```sh * $ pulumi import sumologic:index/ingestBudgetV2:IngestBudgetV2 budget 00000000000123AB * ``` * * ```sh * $ pulumi import sumologic:index/ingestBudgetV2:IngestBudgetV2 dev_budget "DevelopersBudget" * ``` * * [1]: https://help.sumologic.com/Beta/Metadata_Ingest_Budgets * * [2]: https://en.wikipedia.org/wiki/Tz_database */ export declare class IngestBudgetV2 extends pulumi.CustomResource { /** * Get an existing IngestBudgetV2 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?: IngestBudgetV2State, opts?: pulumi.CustomResourceOptions): IngestBudgetV2; /** * Returns true if the given object is an instance of IngestBudgetV2. 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 IngestBudgetV2; /** * Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`. */ readonly action: pulumi.Output; /** * The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. * * The following attributes are exported: */ readonly auditThreshold: pulumi.Output; /** * The type of budget. Supported values are: * `dailyVolume` * `minuteVolume`. Default value is `dailyVolume`. */ readonly budgetType: pulumi.Output; /** * Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. The capacity bytes unit varies based on the budgetType field. For `dailyVolume` budgetType the capacity specified is in bytes/day whereas for `minuteVolume` budgetType its bytes/min. */ readonly capacityBytes: pulumi.Output; /** * The description of the collector. */ readonly description: pulumi.Output; /** * Display name of the ingest budget. This must be unique across all of the ingest budgets */ readonly name: pulumi.Output; /** * Reset time of the ingest budget in HH:MM format. Defaults to `00:00` */ readonly resetTime: pulumi.Output; /** * A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. */ readonly scope: pulumi.Output; /** * The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention. Defaults to `Etc/UTC` */ readonly timezone: pulumi.Output; /** * Create a IngestBudgetV2 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: IngestBudgetV2Args, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IngestBudgetV2 resources. */ export interface IngestBudgetV2State { /** * Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`. */ action?: pulumi.Input; /** * The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. * * The following attributes are exported: */ auditThreshold?: pulumi.Input; /** * The type of budget. Supported values are: * `dailyVolume` * `minuteVolume`. Default value is `dailyVolume`. */ budgetType?: pulumi.Input; /** * Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. The capacity bytes unit varies based on the budgetType field. For `dailyVolume` budgetType the capacity specified is in bytes/day whereas for `minuteVolume` budgetType its bytes/min. */ capacityBytes?: pulumi.Input; /** * The description of the collector. */ description?: pulumi.Input; /** * Display name of the ingest budget. This must be unique across all of the ingest budgets */ name?: pulumi.Input; /** * Reset time of the ingest budget in HH:MM format. Defaults to `00:00` */ resetTime?: pulumi.Input; /** * A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. */ scope?: pulumi.Input; /** * The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention. Defaults to `Etc/UTC` */ timezone?: pulumi.Input; } /** * The set of arguments for constructing a IngestBudgetV2 resource. */ export interface IngestBudgetV2Args { /** * Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`. */ action: pulumi.Input; /** * The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. * * The following attributes are exported: */ auditThreshold?: pulumi.Input; /** * The type of budget. Supported values are: * `dailyVolume` * `minuteVolume`. Default value is `dailyVolume`. */ budgetType?: pulumi.Input; /** * Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. The capacity bytes unit varies based on the budgetType field. For `dailyVolume` budgetType the capacity specified is in bytes/day whereas for `minuteVolume` budgetType its bytes/min. */ capacityBytes: pulumi.Input; /** * The description of the collector. */ description?: pulumi.Input; /** * Display name of the ingest budget. This must be unique across all of the ingest budgets */ name?: pulumi.Input; /** * Reset time of the ingest budget in HH:MM format. Defaults to `00:00` */ resetTime: pulumi.Input; /** * A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. */ scope: pulumi.Input; /** * The time zone to use for this collector. The value follows the [tzdata](https://en.wikipedia.org/wiki/Tz_database) naming convention. Defaults to `Etc/UTC` */ timezone: pulumi.Input; }