[github/fretlink/terraform-provider-statuscake.git] / r / test.html.markdown

---
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
  contact_id   = 12345
}
```

## 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
* `contact_id` - (Optional) The id of the contact group to be add to the test.  Each test can have only one.
* `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.
* `contact_id` - (Optional) The ID of the contact group to associate with the test.
* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0.
* `port` - (Optional) The port to use when specifying a TCP test.


## Attributes Reference

The following attribute is exported:

* `test_id` - A unique identifier for the test.
Commit	Line	Data
d3491090	1	---
	2	layout: "statuscake"
	3	page_title: "StatusCake: statuscake_test"
	4	sidebar_current: "docs-statuscake-test"
	5	description: \|-
	6	The statuscake_test resource allows StatusCake tests to be managed by Terraform.
	7	---
	8
	9	# statuscake\_test
	10
6f91d719	11	The test resource allows StatusCake tests to be managed by Terraform.
d3491090	12
	13	## Example Usage
	14
	15	```
	16	resource "statuscake_test" "google" {
506e71e5 GC	17	website_name = "google.com"
	18	website_url = "www.google.com"
	19	test_type = "HTTP"
	20	check_rate = 300
	21	contact_id = 12345
d3491090	22	}
	23	```
	24
	25	## Argument Reference
	26
	27	The following arguments are supported:
	28
	29	* `website_name` - (Required) This is the name of the test and the website to be monitored.
	30	* `website_url` - (Required) The URL of the website to be monitored
	31	* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300
6c360ff2	32	* `contact_id` - (Optional) The id of the contact group to be add to the test. Each test can have only one.
d3491090	33	* `test_type` - (Required) The type of Test. Either HTTP or TCP
	34	* `paused` - (Optional) Whether or not the test is paused. Defaults to false.
	35	* `timeout` - (Optional) The timeout of the test in seconds.
8a16ad02	36	* `contact_id` - (Optional) The ID of the contact group to associate with the test.
8165842a	37	* `confirmations` - (Optional) The number of confirmation servers to use in order to detect downtime. Defaults to 0.
46abe953	38	* `port` - (Optional) The port to use when specifying a TCP test.
d3491090	39
	40
	41	## Attributes Reference
	42
	43	The following attribute is exported:
	44
6f91d719	45	* `test_id` - A unique identifier for the test.