diff options
Diffstat (limited to 'website/docs')
-rw-r--r-- | website/docs/index.html.markdown | 10 | ||||
-rw-r--r-- | website/docs/r/contact_group.html.markdown | 47 |
2 files changed, 56 insertions, 1 deletions
diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index db2e56d..f45b0e0 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown | |||
@@ -3,7 +3,8 @@ layout: "statuscake" | |||
3 | page_title: "Provider: StatusCake" | 3 | page_title: "Provider: StatusCake" |
4 | sidebar_current: "docs-statuscake-index" | 4 | sidebar_current: "docs-statuscake-index" |
5 | description: |- | 5 | description: |- |
6 | The StatusCake provider configures tests and in StatusCake. | 6 | |
7 | The StatusCake provider configures tests and contact groups in StatusCake. | ||
7 | --- | 8 | --- |
8 | 9 | ||
9 | # StatusCake Provider | 10 | # StatusCake Provider |
@@ -47,4 +48,11 @@ resource "statuscake_ssl" "google" { | |||
47 | alert_broken = false | 48 | alert_broken = false |
48 | alert_mixed = true | 49 | alert_mixed = true |
49 | } | 50 | } |
51 | |||
52 | resource "statuscake_contact_group" "exemple" { | ||
53 | emails= ["email1","email2"] | ||
54 | group_name= "group name" | ||
55 | ping_url= "url" | ||
56 | } | ||
57 | |||
50 | ``` | 58 | ``` |
diff --git a/website/docs/r/contact_group.html.markdown b/website/docs/r/contact_group.html.markdown new file mode 100644 index 0000000..ed3354f --- /dev/null +++ b/website/docs/r/contact_group.html.markdown | |||
@@ -0,0 +1,47 @@ | |||
1 | --- | ||
2 | layout: "statuscake" | ||
3 | page_title: "StatusCake: statuscake_contact_group" | ||
4 | sidebar_current: "docs-statuscake-contact_group" | ||
5 | description: |- | ||
6 | The statuscake_contact_group resource allows StatusCake contact groups to be managed by Terraform. | ||
7 | --- | ||
8 | |||
9 | # statuscake\_contact_group | ||
10 | |||
11 | The contact_group resource allows StatusCake contact groups to be managed by Terraform. | ||
12 | |||
13 | ## Example Usage | ||
14 | |||
15 | ```hcl | ||
16 | resource "statuscake_contact_group" "exemple" { | ||
17 | emails= ["email1","email2"] | ||
18 | group_name= "group name" | ||
19 | ping_url= "url" | ||
20 | } | ||
21 | ``` | ||
22 | |||
23 | ## Argument Reference | ||
24 | |||
25 | The following arguments are supported: | ||
26 | |||
27 | * `desktop_alert` - (Required) Set to 1 To Enable Desktop Alerts | ||
28 | * `ping_url` - (Optional) | ||
29 | * `group_name` - (Optional) The internal Group Name | ||
30 | * `pushover` - (Optional) A Pushover Account Key | ||
31 | * `boxcar` - (Optional) A Boxcar API Key | ||
32 | * `mobiles` - (Optional) Comma Seperated List of International Format Cell Numbers | ||
33 | * `emails` - (Optional) List of Emails To Alert. | ||
34 | |||
35 | ## Attributes Reference | ||
36 | |||
37 | The following attribute is exported: | ||
38 | |||
39 | * `contact_id` - A unique identifier for the contact group. | ||
40 | |||
41 | ## Import | ||
42 | |||
43 | StatusCake contact groups can be imported using the contact group id, e.g. | ||
44 | |||
45 | ``` | ||
46 | tf import statuscake_contact_group.example 123 | ||
47 | ``` | ||