Skip to content

Commit caebd0b

Browse files
committed
improved documentation
1 parent 612bfb7 commit caebd0b

File tree

4 files changed

+96
-7
lines changed

4 files changed

+96
-7
lines changed

docs/resources/kibana_maintenance_window.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,46 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "elasticstack_kibana_maintenance_window Resource - terraform-provider-elasticstack"
4-
subcategory: ""
2+
subcategory: "Kibana"
3+
layout: ""
4+
page_title: "Elasticstack: elasticstack_kibana_maintenance_window Resource"
55
description: |-
6-
Manages Kibana data views
6+
Manages Kibana maintenance windows.
77
---
88

9-
# elasticstack_kibana_maintenance_window (Resource)
9+
# Resource: elasticstack_kibana_maintenance_window
1010

11-
Manages Kibana data views
11+
Creates and manages Kibana [maintenance windows](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-maintenance-window)
1212

13+
## Example Usage
1314

15+
```terraform
16+
provider "elasticstack" {
17+
elasticsearch {}
18+
kibana {}
19+
}
20+
21+
resource "elasticstack_kibana_maintenance_window" "my_maintenance_window" {
22+
title = "UPDATE TEST"
23+
enabled = true
24+
25+
custom_schedule {
26+
start = "1993-01-01T05:00:00.200Z"
27+
duration = "12d"
28+
29+
recurring {
30+
every = "21d"
31+
on_week_day = ["MO", "+3TU", "-2FR"]
32+
on_month_day = [1, 2, 4, 6, 7]
33+
on_month = [12]
34+
}
35+
}
36+
37+
scope {
38+
alerting {
39+
kql = "_id: '1234'"
40+
}
41+
}
42+
}
43+
```
1444

1545
<!-- schema generated by tfplugindocs -->
1646
## Schema
@@ -28,7 +58,7 @@ Manages Kibana data views
2858

2959
### Read-Only
3060

31-
- `id` (String) Generated ID for the data view.
61+
- `id` (String) Generated ID for the maintenance window.
3262

3363
<a id="nestedatt--custom_schedule"></a>
3464
### Nested Schema for `custom_schedule`
@@ -70,3 +100,11 @@ Required:
70100
Required:
71101

72102
- `kql` (String) A filter written in Kibana Query Language (KQL).
103+
104+
## Import
105+
106+
Import is supported using the following syntax:
107+
108+
```shell
109+
terraform import elasticstack_kibana_maintenance_window.my_maintenance_window <space id>/<maintenance window id>
110+
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
terraform import elasticstack_kibana_maintenance_window.my_maintenance_window <space id>/<maintenance window id>
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
provider "elasticstack" {
2+
elasticsearch {}
3+
kibana {}
4+
}
5+
6+
resource "elasticstack_kibana_maintenance_window" "my_maintenance_window" {
7+
title = "UPDATE TEST"
8+
enabled = true
9+
10+
custom_schedule {
11+
start = "1993-01-01T05:00:00.200Z"
12+
duration = "12d"
13+
14+
recurring {
15+
every = "21d"
16+
on_week_day = ["MO", "+3TU", "-2FR"]
17+
on_month_day = [1, 2, 4, 6, 7]
18+
on_month = [12]
19+
}
20+
}
21+
22+
scope {
23+
alerting {
24+
kql = "_id: '1234'"
25+
}
26+
}
27+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
subcategory: "Kibana"
3+
layout: ""
4+
page_title: "Elasticstack: elasticstack_kibana_maintenance_window Resource"
5+
description: |-
6+
Manages Kibana maintenance windows.
7+
---
8+
9+
# Resource: elasticstack_kibana_maintenance_window
10+
11+
Creates and manages Kibana [maintenance windows](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-maintenance-window)
12+
13+
## Example Usage
14+
15+
{{ tffile "examples/resources/elasticstack_kibana_maintenance_window/resource.tf" }}
16+
17+
{{ .SchemaMarkdown | trimspace }}
18+
19+
## Import
20+
21+
Import is supported using the following syntax:
22+
23+
{{ codefile "shell" "examples/resources/elasticstack_kibana_maintenance_window/import.sh" }}

0 commit comments

Comments
 (0)