Skip to content

[ResponseOps] Maintenance Window Resource #1037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/resources/kibana_maintenance_window.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_kibana_maintenance_window Resource - terraform-provider-elasticstack"
subcategory: ""
description: |-
Creates a Kibana Maintenance Window.
---

# elasticstack_kibana_maintenance_window (Resource)

Creates a Kibana Maintenance Window.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `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))
- `title` (String) The name of the maintenance window.

### Optional

- `enabled` (Boolean) Whether the current maintenance window is enabled.
- `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))
- `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used.

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--custom_schedule"></a>
### Nested Schema for `custom_schedule`

Required:

- `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`.
- `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`.

Optional:

- `recurring` (Block List, Max: 1) (see [below for nested schema](#nestedblock--custom_schedule--recurring))
- `timezone` (String) The timezone of the schedule. The default timezone is UTC.

<a id="nestedblock--custom_schedule--recurring"></a>
### Nested Schema for `custom_schedule.recurring`

Optional:

- `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`.
- `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`.
- `occurrences` (Number) The total number of recurrences of the schedule.
- `on_month` (List of Number) The specific months for a recurring schedule. Valid values are 1-12.
- `on_month_day` (List of Number) The specific days of the month for a recurring schedule. Valid values are 1-31.
- `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.



<a id="nestedblock--scope"></a>
### Nested Schema for `scope`

Optional:

- `alerting` (Block List, Max: 1) (see [below for nested schema](#nestedblock--scope--alerting))

<a id="nestedblock--scope--alerting"></a>
### Nested Schema for `scope.alerting`

Required:

- `kql` (String) A filter written in Kibana Query Language (KQL).
33 changes: 33 additions & 0 deletions generated/alerting/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ docs/AlertResponseProperties.md
docs/AlertResponsePropertiesExecutionStatus.md
docs/AlertResponsePropertiesSchedule.md
docs/AlertingAPI.md
docs/CreateMaintenanceWindowRequest.md
docs/CreateMaintenanceWindowRequestSchedule.md
docs/CreateMaintenanceWindowRequestScheduleCustom.md
docs/CreateMaintenanceWindowRequestScheduleCustomRecurring.md
docs/CreateMaintenanceWindowRequestScope.md
docs/CreateMaintenanceWindowRequestScopeAlerting.md
docs/CreateMaintenanceWindowRequestScopeAlertingQuery.md
docs/CreateRuleRequest.md
docs/FieldmapProperties.md
docs/FieldmapPropertiesPropertiesValue.md
Expand Down Expand Up @@ -54,21 +61,32 @@ docs/LegacyGetAlertingHealth200ResponseAlertingFrameworkHealthReadHealth.md
docs/LegacyUpdateAlertRequestProperties.md
docs/LegacyUpdateAlertRequestPropertiesActionsInner.md
docs/LegacyUpdateAlertRequestPropertiesSchedule.md
docs/MaintenanceWindowResponseProperties.md
docs/MaintenanceWindowResponsePropertiesSchedule.md
docs/MaintenanceWindowResponsePropertiesScheduleCustom.md
docs/MaintenanceWindowResponsePropertiesScheduleCustomRecurring.md
docs/MaintenanceWindowResponsePropertiesScope.md
docs/MaintenanceWindowResponsePropertiesScopeAlerting.md
docs/MaintenanceWindowResponsePropertiesScopeAlertingQuery.md
docs/Model400Response.md
docs/Model401Response.md
docs/Model403Response.md
docs/Model404Response.md
docs/NotifyWhen.md
docs/NotifyWhenAction.md
docs/RuleResponseProperties.md
docs/RuleResponsePropertiesExecutionStatus.md
docs/RuleResponsePropertiesLastRun.md
docs/RuleResponsePropertiesLastRunAlertsCount.md
docs/Schedule.md
docs/UpdateMaintenanceWindowRequest.md
docs/UpdateRuleRequest.md
git_push.sh
go.mod
go.sum
model_400_response.go
model_401_response.go
model_403_response.go
model_404_response.go
model_actions_inner.go
model_actions_inner_alerts_filter.go
Expand All @@ -80,6 +98,13 @@ model_alert_delay.go
model_alert_response_properties.go
model_alert_response_properties_execution_status.go
model_alert_response_properties_schedule.go
model_create_maintenance_window_request.go
model_create_maintenance_window_request_schedule.go
model_create_maintenance_window_request_schedule_custom.go
model_create_maintenance_window_request_schedule_custom_recurring.go
model_create_maintenance_window_request_scope.go
model_create_maintenance_window_request_scope_alerting.go
model_create_maintenance_window_request_scope_alerting_query.go
model_create_rule_request.go
model_fieldmap_properties.go
model_fieldmap_properties_properties_value.go
Expand Down Expand Up @@ -118,13 +143,21 @@ model_legacy_get_alerting_health_200_response_alerting_framework_health_read_hea
model_legacy_update_alert_request_properties.go
model_legacy_update_alert_request_properties_actions_inner.go
model_legacy_update_alert_request_properties_schedule.go
model_maintenance_window_response_properties.go
model_maintenance_window_response_properties_schedule.go
model_maintenance_window_response_properties_schedule_custom.go
model_maintenance_window_response_properties_schedule_custom_recurring.go
model_maintenance_window_response_properties_scope.go
model_maintenance_window_response_properties_scope_alerting.go
model_maintenance_window_response_properties_scope_alerting_query.go
model_notify_when.go
model_notify_when_action.go
model_rule_response_properties.go
model_rule_response_properties_execution_status.go
model_rule_response_properties_last_run.go
model_rule_response_properties_last_run_alerts_count.go
model_schedule.go
model_update_maintenance_window_request.go
model_update_rule_request.go
response.go
test/api_alerting_test.go
Expand Down
Loading
Loading