|
| 1 | +--- |
| 2 | +layout: "sumologic" |
| 3 | +page_title: "SumoLogic: sumologic_ingest_budget_v2" |
| 4 | +description: |- |
| 5 | + Provides a Sumologic Ingest Budget v2 |
| 6 | +--- |
| 7 | + |
| 8 | +# sumologic_ingest_budget_v2 |
| 9 | +Provides a [Sumologic Ingest Budget v2][1]. |
| 10 | + |
| 11 | +## Example Usage |
| 12 | +```hcl |
| 13 | +resource "sumologic_ingest_budget_v2" "budget" { |
| 14 | + name = "testBudget" |
| 15 | + scope = "_sourceCategory=*prod*nginx*" |
| 16 | + capacity_bytes = 30000000000 |
| 17 | + description = "For testing purposes" |
| 18 | +} |
| 19 | +``` |
| 20 | + |
| 21 | +## Argument Reference |
| 22 | + |
| 23 | +The following arguments are supported: |
| 24 | + |
| 25 | + * `name` - (Required) Display name of the ingest budget. This must be unique across all of the ingest budgets |
| 26 | + * `scope` - (Required) 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. |
| 27 | + * `capacity_bytes` - (Required) Capacity of the ingest budget, in bytes. |
| 28 | + * `description` - (Optional) The description of the collector. |
| 29 | + * `timezone` - (Optional) The time zone to use for this collector. The value follows the [tzdata][2] naming convention. Defaults to `Etc/UTC` |
| 30 | + * `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00` |
| 31 | + * `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00` |
| 32 | + * `description` - (Optional) Description of the ingest budget. |
| 33 | + * `action` - (Optional) Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`. |
| 34 | + |
| 35 | +The following attributes are exported: |
| 36 | + |
| 37 | + * `id` - The internal ID of the ingest budget. This can be used to assign collectors to the ingest budget. |
| 38 | + |
| 39 | +## Import |
| 40 | +Ingest budgets can be imported using the name, e.g.: |
| 41 | + |
| 42 | +```hcl |
| 43 | +terraform import sumologic_ingest_budget_v2.budget budgetName |
| 44 | +``` |
| 45 | + |
| 46 | +[1]: https://help.sumologic.com/Beta/Metadata_Ingest_Budgets |
| 47 | +[2]: https://en.wikipedia.org/wiki/Tz_database |
0 commit comments