|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "elasticstack_kibana_maintenance_window Resource - terraform-provider-elasticstack" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Creates a Kibana Maintenance Window. |
| 7 | +--- |
| 8 | + |
| 9 | +# elasticstack_kibana_maintenance_window (Resource) |
| 10 | + |
| 11 | +Creates a Kibana Maintenance Window. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- schema generated by tfplugindocs --> |
| 16 | +## Schema |
| 17 | + |
| 18 | +### Required |
| 19 | + |
| 20 | +- `custom_schedule` (Block List, Min: 1, Max: 1) A set schedule over which the maintenance window applies. (see [below for nested schema](#nestedblock--custom_schedule)) |
| 21 | +- `title` (String) The name of the maintenance window. |
| 22 | + |
| 23 | +### Optional |
| 24 | + |
| 25 | +- `enabled` (Boolean) Whether the current maintenance window is enabled. |
| 26 | +- `scope` (Block List, Max: 1) An object that narrows the scope of what is affected by this maintenance window. (see [below for nested schema](#nestedblock--scope)) |
| 27 | +- `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used. |
| 28 | + |
| 29 | +### Read-Only |
| 30 | + |
| 31 | +- `id` (String) The ID of this resource. |
| 32 | + |
| 33 | +<a id="nestedblock--custom_schedule"></a> |
| 34 | +### Nested Schema for `custom_schedule` |
| 35 | + |
| 36 | +Required: |
| 37 | + |
| 38 | +- `duration` (String) The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`. |
| 39 | +- `start` (String) The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`. |
| 40 | + |
| 41 | +Optional: |
| 42 | + |
| 43 | +- `recurring` (Block List, Max: 1) (see [below for nested schema](#nestedblock--custom_schedule--recurring)) |
| 44 | +- `timezone` (String) The timezone of the schedule. The default timezone is UTC. |
| 45 | + |
| 46 | +<a id="nestedblock--custom_schedule--recurring"></a> |
| 47 | +### Nested Schema for `custom_schedule.recurring` |
| 48 | + |
| 49 | +Optional: |
| 50 | + |
| 51 | +- `end` (String) The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`. |
| 52 | +- `every` (String) The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`. |
| 53 | +- `occurrences` (Number) The total number of recurrences of the schedule. |
| 54 | +- `on_month` (List of Number) The specific months for a recurring schedule. Valid values are 1-12. |
| 55 | +- `on_month_day` (List of Number) The specific days of the month for a recurring schedule. Valid values are 1-31. |
| 56 | +- `on_week_day` (List of String) The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule. |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +<a id="nestedblock--scope"></a> |
| 61 | +### Nested Schema for `scope` |
| 62 | + |
| 63 | +Optional: |
| 64 | + |
| 65 | +- `alerting` (Block List, Max: 1) (see [below for nested schema](#nestedblock--scope--alerting)) |
| 66 | + |
| 67 | +<a id="nestedblock--scope--alerting"></a> |
| 68 | +### Nested Schema for `scope.alerting` |
| 69 | + |
| 70 | +Required: |
| 71 | + |
| 72 | +- `kql` (String) A filter written in Kibana Query Language (KQL). |
0 commit comments