Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jhanrahan-sigsci committed Feb 23, 2021
1 parent 3aef32e commit ed5b4c7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
20 changes: 11 additions & 9 deletions docs/resources/site_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

```hcl-terraform
resource "sigsci_site_alert" "test" {
site_short_name = sigsci_site.my-site.short_name
tag_name = sigsci_site_signal_tag.test_tag.id
long_name = "test_alert"
interval = 10
threshold = 12
enabled = true
action = "info"
site_short_name = sigsci_site.my-site.short_name
tag_name = sigsci_site_signal_tag.test_tag.id
long_name = "test_alert"
interval = 10
threshold = 12
enabled = true
action = "info"
skip_notifications = true
}
```

Expand All @@ -19,8 +20,9 @@ resource "sigsci_site_alert" "test" {
- `interval` - The number of minutes of past traffic to examine. Must be 1, 10 or 60.
- `threshold` - The number of occurrences of the tag in the interval needed to trigger the alert.
- `action` - A flag that describes what happens when the alert is triggered. 'info' creates an incident in the dashboard. 'flagged' creates an incident and blocks traffic for 24 hours.

### Import
- `skip_notifications` - A boolean flag to send notifications

### Import
You can import corp lists with the generic site import formula

### Attributes Reference
Expand Down
2 changes: 1 addition & 1 deletion provider/resource_site_alert.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func resourceSiteAlert() *schema.Resource {
},
"skip_notifications": {
Type: schema.TypeBool,
Description: "A flag skips notifications",
Description: "A flag to skip notifications",
Optional: true,
},
},
Expand Down

0 comments on commit ed5b4c7

Please sign in to comment.