Add documentation for `service_integration`

This commit is contained in:
Alexander Hellbom 2016-10-16 19:01:27 +02:00
parent 074e989846
commit fddefa6f33
2 changed files with 75 additions and 0 deletions

View File

@ -0,0 +1,72 @@
---
layout: "pagerduty"
page_title: "PagerDuty: pagerduty_service_integration"
sidebar_current: "docs-pagerduty-resource-service-integration"
description: |-
Creates and manages a service integration in PagerDuty.
---
# pagerduty\_service_integration
A [service integration](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Services/post_services_id_integrations) is an integration that belongs to a service.
## Example Usage
```
resource "pagerduty_user" "example" {
name = "Earline Greenholt"
email = "125.greenholt.earline@graham.name"
teams = ["${pagerduty_team.example.id}"]
}
resource "pagerduty_escalation_policy" "foo" {
name = "Engineering Escalation Policy"
num_loops = 2
escalation_rule {
escalation_delay_in_minutes = 10
target {
type = "user"
id = "${pagerduty_user.example.id}"
}
}
}
resource "pagerduty_service" "example" {
name = "My Web App"
auto_resolve_timeout = 14400
acknowledgement_timeout = 600
escalation_policy = "${pagerduty_escalation_policy.example.id}"
}
resource "pagerduty_service_integration" "example" {
name = "Generic API Service Integration"
type = "generic_events_api_inbound_integration"
service = "${pagerduty_service.example.id}"
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Optional) The name of the service integration.
* `type` - (Optional) The service type. Can be `aws_cloudwatch_inbound_integration`, `cloudkick_inbound_integration`,
`event_transformer_api_inbound_integration`,
`generic_email_inbound_integration`,
`generic_events_api_inbound_integration`,
`keynote_inbound_integration`,
`nagios_inbound_integration`,
`pingdom_inbound_integration`,
`sql_monitor_inbound_integration`
* `service` - (Optional) The PagerDuty service that the integration belongs to.
## Attributes Reference
The following attributes are exported:
* `id` - The ID of the service integration.
* `integration_key` - This is the unique key used to route events to this integration when received via the PagerDuty Events API.
* `integration_email` - This is the unique fully-qualified email address used for routing emails to this integration for processing.

View File

@ -28,6 +28,9 @@
<li<%= sidebar_current("docs-pagerduty-resource-service") %>>
<a href="/docs/providers/pagerduty/r/service.html">pagerduty_service</a>
</li>
<li<%= sidebar_current("docs-pagerduty-resource-service-integration") %>>
<a href="/docs/providers/pagerduty/r/service_integration.html">pagerduty_service_integration</a>
</li>
</ul>
</li>
</ul>