Class Schedule
A schedule determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.
Example Usage
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;
class MyStack : Stack
{
public MyStack()
{
var example = new Pagerduty.User("example", new Pagerduty.UserArgs
{
Email = "125.greenholt.earline@graham.name",
Teams =
{
pagerduty_team.Example.Id,
},
});
var foo = new Pagerduty.Schedule("foo", new Pagerduty.ScheduleArgs
{
Layers =
{
new Pagerduty.Inputs.ScheduleLayerArgs
{
Name = "Night Shift",
Restriction =
{
{
{ "durationSeconds", 32400 },
{ "startTimeOfDay", "08:00:00" },
{ "type", "daily_restriction" },
},
},
RotationTurnLengthSeconds = 86400,
RotationVirtualStart = "2015-11-06T20:00:00-05:00",
Start = "2015-11-06T20:00:00-05:00",
Users =
{
pagerduty_user.Foo.Id,
},
},
},
TimeZone = "America/New_York",
});
}
}
Inheritance
Inherited Members
Namespace: Pulumi.Pagerduty
Assembly: Pulumi.Pagerduty.dll
Syntax
public class Schedule : CustomResource
Constructors
View SourceSchedule(String, ScheduleArgs, CustomResourceOptions)
Create a Schedule resource with the given unique name, arguments, and options.
Declaration
public Schedule(string name, ScheduleArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| ScheduleArgs | args | The arguments used to populate this resource's properties |
| Pulumi.CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceDescription
The description of the schedule
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Pulumi.Output<System.String> |
Layers
A schedule layer block. Schedule layers documented below.
Declaration
public Output<ImmutableArray<ScheduleLayer>> Layers { get; }
Property Value
| Type | Description |
|---|---|
| Pulumi.Output<System.Collections.Immutable.ImmutableArray<ScheduleLayer>> |
Name
The name of the schedule.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Pulumi.Output<System.String> |
Overflow
Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow is passed. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:
If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z.
If you do pass the overflow parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.
Declaration
public Output<bool?> Overflow { get; }
Property Value
| Type | Description |
|---|---|
| Pulumi.Output<System.Nullable<System.Boolean>> |
TimeZone
The time zone of the schedule (e.g Europe/Berlin).
Declaration
public Output<string> TimeZone { get; }
Property Value
| Type | Description |
|---|---|
| Pulumi.Output<System.String> |
Methods
View SourceGet(String, Input<String>, ScheduleState, CustomResourceOptions)
Get an existing Schedule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Schedule Get(string name, Input<string> id, ScheduleState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Pulumi.Input<System.String> | id | The unique provider ID of the resource to lookup. |
| ScheduleState | state | Any extra arguments used during the lookup. |
| Pulumi.CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Schedule |