83 lines
2.7 KiB
Markdown
83 lines
2.7 KiB
Markdown
|
---
|
||
|
|
layout: "pagerduty"
|
||
|
|
page_title: "PagerDuty: pagerduty_schedule"
|
||
|
|
sidebar_current: "docs-pagerduty-resource-schedule"
|
||
|
|
description: |-
|
||
|
|
Creates and manages a schedule in PagerDuty.
|
||
|
|
---
|
||
|
|
|
||
|
|
# pagerduty\_schedule
|
||
|
|
|
||
|
|
A [schedule](https://v2.developer.pagerduty.com/v2/page/api-reference#!/Schedules/get_schedules) determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.
|
||
|
|
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
```
|
||
|
|
resource "pagerduty_user" "example" {
|
||
|
|
name = "Earline Greenholt"
|
||
|
|
email = "125.greenholt.earline@graham.name"
|
||
|
|
teams = ["${pagerduty_team.example.id}"]
|
||
|
|
}
|
||
|
|
|
||
|
|
resource "pagerduty_schedule" "foo" {
|
||
|
|
name = "Daily Engineering Rotation"
|
||
|
|
time_zone = "America/New_York"
|
||
|
|
|
||
|
|
schedule_layer {
|
||
|
|
name = "Night Shift"
|
||
|
|
start = "2015-11-06T20:00:00-05:00"
|
||
|
|
rotation_virtual_start = "2015-11-06T20:00:00-05:00"
|
||
|
|
rotation_turn_length_seconds = 86400
|
||
|
|
users = ["${pagerduty_user.foo.id}"]
|
||
|
|
|
||
|
|
restriction {
|
||
|
|
type = "daily_restriction"
|
||
|
|
start_time_of_day = "08:00:00"
|
||
|
|
duration_seconds = 32400
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Argument Reference
|
||
|
|
|
||
|
|
The following arguments are supported:
|
||
|
|
|
||
|
|
* `name` - (Optional) The name of the escalation policy.
|
||
|
|
* `time_zone` - (Required) The time zone of the schedule (e.g Europe/Berlin).
|
||
|
|
* `description` - (Optional) The description of the schedule
|
||
|
|
* `schedule_layer` - (Required) A schedule layer block. Schedule layers documented below.
|
||
|
|
|
||
|
|
|
||
|
|
Schedule layers (`schedule_layer`) supports the following:
|
||
|
|
|
||
|
|
* `name` - (Optional) The name of the schedule layer.
|
||
|
|
* `start` - (Required) The start time of the schedule layer.
|
||
|
|
* `end` - (Optional) The end time of the schedule layer. If not specified, the layer does not end.
|
||
|
|
* `rotation_virtual_start` - (Required) The effective start time of the schedule layer. This can be before the start time of the schedule.
|
||
|
|
* `rotation_turn_length_seconds` - (Required) The duration of each on-call shift in `seconds`.
|
||
|
|
* `users` - (Required) The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
|
||
|
|
* `restriction` - (Optional) A schedule layer restriction block. Restriction blocks documented below.
|
||
|
|
|
||
|
|
|
||
|
|
Restriction blocks (`restriction`) supports the following:
|
||
|
|
|
||
|
|
* `type` - (Required) Can be `daily_restriction` or `weekly_restriction`
|
||
|
|
* `start_time_of_day` - (Required) The duration of the restriction in `seconds`.
|
||
|
|
* `duration_seconds` - (Required) The start time in `HH:mm:ss` format.
|
||
|
|
|
||
|
|
## Attributes Reference
|
||
|
|
|
||
|
|
The following attributes are exported:
|
||
|
|
|
||
|
|
* `id` - The ID of the schedule
|
||
|
|
|
||
|
|
## Import
|
||
|
|
|
||
|
|
Schedules can be imported using the `id`, e.g.
|
||
|
|
|
||
|
|
```
|
||
|
|
$ terraform import pagerduty_schedule.main PLBP09X
|
||
|
|
```
|