[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
}
```

## 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.
* `contact_id` - (Optional) The ID of the contact group to associate with the 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
	11	The test resource allows StatusCake tests to be managed by Terraform.
	12
	13	## Example Usage
	14
	15	```
	16	resource "statuscake_test" "google" {
	17	website_name = "google.com"
	18	website_url = "www.google.com"
	19	test_type = "HTTP"
	20	check_rate = 300
	21	}
	22	```
	23
	24	## Argument Reference
	25
	26	The following arguments are supported:
	27
	28	* `website_name` - (Required) This is the name of the test and the website to be monitored.
	29	* `website_url` - (Required) The URL of the website to be monitored
	30	* `check_rate` - (Optional) Test check rate in seconds. Defaults to 300
	31	* `test_type` - (Required) The type of Test. Either HTTP or TCP
	32	* `paused` - (Optional) Whether or not the test is paused. Defaults to false.
	33	* `timeout` - (Optional) The timeout of the test in seconds.
8a16ad02	34	* `contact_id` - (Optional) The ID of the contact group to associate with the test.
d3491090	35
	36
	37	## Attributes Reference
	38
	39	The following attribute is exported:
	40
	41	* `test_id` - A unique identifier for the test.