From d3491090f8b1844d84b8d09394f11f28545b8355 Mon Sep 17 00:00:00 2001 From: stack72 Date: Sat, 28 Nov 2015 01:03:15 +0000 Subject: Adding some documentation for the StatusCake provider --- r/test.html.markdown | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 r/test.html.markdown (limited to 'r/test.html.markdown') diff --git a/r/test.html.markdown b/r/test.html.markdown new file mode 100644 index 0000000..d2d1572 --- /dev/null +++ b/r/test.html.markdown @@ -0,0 +1,40 @@ +--- +layout: "statuscake" +page_title: "StatusCake: statuscake_test" +sidebar_current: "docs-statuscake-test" +description: |- + The statuscake_test resource allows StatusCake tests to be managed by Terraform. +--- + +# statuscake\_test + +The test resource allows StatusCake tests to be managed by Terraform. + +## Example Usage + +``` +resource "statuscake_test" "google" { + website_name = "google.com" + website_url = "www.google.com" + test_type = "HTTP" + check_rate = 300 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `website_name` - (Required) This is the name of the test and the website to be monitored. +* `website_url` - (Required) The URL of the website to be monitored +* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300 +* `test_type` - (Required) The type of Test. Either HTTP or TCP +* `paused` - (Optional) Whether or not the test is paused. Defaults to false. +* `timeout` - (Optional) The timeout of the test in seconds. + + +## Attributes Reference + +The following attribute is exported: + +* `test_id` - A unique identifier for the test. \ No newline at end of file -- cgit v1.2.3