Skip to content

Commit accf3ba

Browse files
tomasbashamtomasbasham
committed
Add provider documentation
Documentation is generated using the HashiCorp terraform-plugin-docs project and invoked with `go generate ./...`.
1 parent f532c68 commit accf3ba

File tree

20 files changed

+842
-0
lines changed

20 files changed

+842
-0
lines changed

‎docs/data-sources/pagespeed_monitoring_locations.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_pagespeed_monitoring_locations Data Source - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_pagespeed_monitoring_locations (Data Source)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "statuscake_pagespeed_monitoring_locations" "pagespeed" {
17+
region_code = "GB"
18+
}
19+
20+
output "pagespeed_monitoring_location_ips" {
21+
value = toset([for loc in data.statuscake_pagespeed_monitoring_locations.pagespeed.locations : loc.ipv4])
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Optional
29+
30+
- **id** (String) The ID of this resource.
31+
- **region_code** (String) Location region code
32+
33+
### Read-Only
34+
35+
- **locations** (List of Object) List of monitoring locations (see [below for nested schema](#nestedatt--locations))
36+
37+
<a id="nestedatt--locations"></a>
38+
### Nested Schema for `locations`
39+
40+
Read-Only:
41+
42+
- **description** (String)
43+
- **ipv4** (String)
44+
- **ipv6** (String)
45+
- **region** (String)
46+
- **region_code** (String)
47+
- **status** (String)
48+
49+

‎docs/data-sources/uptime_monitoring_locations.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_uptime_monitoring_locations Data Source - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_uptime_monitoring_locations (Data Source)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "statuscake_uptime_monitoring_locations" "uptime" {
17+
region_code = "GBR"
18+
}
19+
20+
output "uptime_monitoring_location_ips" {
21+
value = toset([for loc in data.statuscake_uptime_monitoring_locations.uptime.locations : loc.ipv4])
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Optional
29+
30+
- **id** (String) The ID of this resource.
31+
- **region_code** (String) Location region code
32+
33+
### Read-Only
34+
35+
- **locations** (List of Object) List of monitoring locations (see [below for nested schema](#nestedatt--locations))
36+
37+
<a id="nestedatt--locations"></a>
38+
### Nested Schema for `locations`
39+
40+
Read-Only:
41+
42+
- **description** (String)
43+
- **ipv4** (String)
44+
- **ipv6** (String)
45+
- **region** (String)
46+
- **region_code** (String)
47+
- **status** (String)
48+
49+

‎docs/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake Provider"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake Provider
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
provider "statuscake" {
17+
api_token = "my-api-token"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Required
25+
26+
- **api_token** (String) The API token for operations
27+
28+
### Optional
29+
30+
- **max_backoff** (Number) Maximum backoff period in seconds after failed API calls
31+
- **min_backoff** (Number) Minimum backoff period in seconds after failed API calls
32+
- **retries** (Number) Maximum number of retries to perform when an API request fails
33+
- **rps** (Number) RPS limit to apply when making calls to the API
34+
- **statuscake_custom_endpoint** (String) Custom endpoint to which request will be made

‎docs/resources/contact_group.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_contact_group Resource - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_contact_group (Resource)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "statuscake_contact_group" "operations_team" {
17+
name = "Operations Team"
18+
ping_url = "https://www.example.com"
19+
20+
email_addresses = [
21+
"johnsmith@example.com",
22+
"janesmith@example.com",
23+
]
24+
}
25+
26+
output "operations_team_contact_group_id" {
27+
value = statuscake_contact_group.operations_team.id
28+
}
29+
```
30+
31+
<!-- schema generated by tfplugindocs -->
32+
## Schema
33+
34+
### Required
35+
36+
- **name** (String) Name of the contact group
37+
38+
### Optional
39+
40+
- **email_addresses** (Set of String) List of email addresses
41+
- **id** (String) The ID of this resource.
42+
- **integrations** (Set of String) List of integration IDs
43+
- **mobile_numbers** (Set of String) List of international format mobile phone numbers
44+
- **ping_url** (String) URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
45+
46+

‎docs/resources/maintenance_window.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_maintenance_window Resource - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_maintenance_window (Resource)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "statuscake_maintenance_window" "weekends" {
17+
name = "Weekends"
18+
timezone = "UTC"
19+
20+
start = "2022-01-29T00:00:00Z"
21+
end = "2022-01-30T23:59:59Z"
22+
repeat_interval = "1w"
23+
24+
tags = [
25+
"production"
26+
]
27+
28+
tests = [
29+
statuscake_uptime_check.statuscake_com.id,
30+
]
31+
}
32+
```
33+
34+
<!-- schema generated by tfplugindocs -->
35+
## Schema
36+
37+
### Required
38+
39+
- **end** (String) End of the maintenance window (RFC3339 format)
40+
- **name** (String) Name of the maintenance window
41+
- **start** (String) Start of the maintenance window (RFC3339 format)
42+
- **timezone** (String) Standard timezone associated with this maintenance window
43+
44+
### Optional
45+
46+
- **id** (String) The ID of this resource.
47+
- **repeat_interval** (String) How often the maintenance window should occur
48+
- **tags** (Set of String) List of tags used to include matching uptime checks in this maintenance window
49+
- **tests** (Set of String) List of uptime check IDs explicitly included in this maintenance window
50+
51+

‎docs/resources/pagespeed_check.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_pagespeed_check Resource - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_pagespeed_check (Resource)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "statuscake_pagespeed_check" "example_com" {
17+
name = "Example"
18+
check_interval = 300
19+
region = "UK"
20+
21+
contact_groups = [
22+
statuscake_contact_group.operations_team.id
23+
]
24+
25+
alert_config {
26+
alert_bigger = "5000"
27+
}
28+
29+
monitored_resource {
30+
address = "https://www.example.com"
31+
}
32+
}
33+
34+
output "example_com_pagespeed_check_id" {
35+
value = statuscake_pagespeed_check.example_com.id
36+
}
37+
```
38+
39+
<!-- schema generated by tfplugindocs -->
40+
## Schema
41+
42+
### Required
43+
44+
- **alert_config** (Block List, Min: 1, Max: 1) Alert configuration block. Omitting this block disabled all alerts (see [below for nested schema](#nestedblock--alert_config))
45+
- **check_interval** (Number) Number of seconds between checks
46+
- **monitored_resource** (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
47+
- **name** (String) Name of the check
48+
- **region** (String) Region on which to run checks
49+
50+
### Optional
51+
52+
- **contact_groups** (Set of String) List of contact group IDs
53+
- **id** (String) The ID of this resource.
54+
- **paused** (Boolean) Whether the check should be run
55+
56+
### Read-Only
57+
58+
- **location** (String) Assigned monitoring location on which checks will be run
59+
60+
<a id="nestedblock--alert_config"></a>
61+
### Nested Schema for `alert_config`
62+
63+
Optional:
64+
65+
- **alert_bigger** (Number) An alert will be sent if the size of the page is larger than this value (kb).
66+
- **alert_slower** (Number) An alert will be sent if the load time of the page exceeds this value (ms).
67+
- **alert_smaller** (Number) An alert will be sent if the size of the page is smaller than this value (kb).
68+
69+
70+
<a id="nestedblock--monitored_resource"></a>
71+
### Nested Schema for `monitored_resource`
72+
73+
Required:
74+
75+
- **address** (String) URL or IP address of the website under test
76+
77+

‎docs/resources/ssl_check.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "statuscake_ssl_check Resource - terraform-provider-statuscake"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# statuscake_ssl_check (Resource)
10+
11+
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "statuscake_ssl_check" "example_com" {
17+
check_interval = 600
18+
user_agent = "terraform managed SSL check"
19+
20+
contact_groups = [
21+
statuscake_contact_group.operations_team.id
22+
]
23+
24+
alert_config {
25+
alert_at = [7, 14, 21]
26+
27+
on_reminder = true
28+
on_expiry = true
29+
on_broken = false
30+
on_mixed = false
31+
}
32+
33+
monitored_resource {
34+
address = "https://www.example.com"
35+
}
36+
}
37+
38+
output "example_com_ssl_check_id" {
39+
value = statuscake_ssl_check.example_com.id
40+
}
41+
```
42+
43+
<!-- schema generated by tfplugindocs -->
44+
## Schema
45+
46+
### Required
47+
48+
- **alert_config** (Block List, Min: 1, Max: 1) Alert configuration block (see [below for nested schema](#nestedblock--alert_config))
49+
- **check_interval** (Number) Number of seconds between checks
50+
- **monitored_resource** (Block List, Min: 1, Max: 1) Monitored resource configuration block. The describes server under test (see [below for nested schema](#nestedblock--monitored_resource))
51+
52+
### Optional
53+
54+
- **contact_groups** (Set of String) List of contact group IDs
55+
- **follow_redirects** (Boolean) Whether to follow redirects when testing. Disabled by default
56+
- **id** (String) The ID of this resource.
57+
- **paused** (Boolean) Whether the check should be run
58+
- **user_agent** (String) Custom user agent string set when testing
59+
60+
<a id="nestedblock--alert_config"></a>
61+
### Nested Schema for `alert_config`
62+
63+
Required:
64+
65+
- **alert_at** (Set of Number) List representing when alerts should be sent (days). Must be exactly 3 numerical values
66+
67+
Optional:
68+
69+
- **on_broken** (Boolean) Whether to enable alerts when SSL certificate issues are found
70+
- **on_expiry** (Boolean) Whether to enable alerts when the SSL certificate is to expire
71+
- **on_mixed** (Boolean) Whether to enable alerts when mixed content is found
72+
- **on_reminder** (Boolean) Whether to enable alert reminders
73+
74+
75+
<a id="nestedblock--monitored_resource"></a>
76+
### Nested Schema for `monitored_resource`
77+
78+
Required:
79+
80+
- **address** (String) URL of the server under test
81+
82+
Optional:
83+
84+
- **hostname** (String) Hostname of the server under test
85+
86+

0 commit comments

Comments
 (0)