Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. Schedule
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-pagerduty

pagerduty.Schedule

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-pagerduty

    A schedule determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";

const example = new pagerduty.User("example", {
    name: "Earline Greenholt",
    email: "125.greenholt.earline@graham.name",
});
const exampleTeam = new pagerduty.Team("example", {name: "A Team"});
const foo = new pagerduty.Schedule("foo", {
    name: "Daily Engineering Rotation",
    timeZone: "America/New_York",
    layers: [{
        name: "Night Shift",
        start: "2015-11-06T20:00:00-05:00",
        rotationVirtualStart: "2015-11-06T20:00:00-05:00",
        rotationTurnLengthSeconds: 86400,
        users: [example.id],
        restrictions: [{
            type: "daily_restriction",
            startTimeOfDay: "08:00:00",
            durationSeconds: 32400,
        }],
    }],
    teams: [exampleTeam.id],
});

    import pulumi
import pulumi_pagerduty as pagerduty

example = pagerduty.User("example",
    name="Earline Greenholt",
    email="125.greenholt.earline@graham.name")
example_team = pagerduty.Team("example", name="A Team")
foo = pagerduty.Schedule("foo",
    name="Daily Engineering Rotation",
    time_zone="America/New_York",
    layers=[{
        "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": [example.id],
        "restrictions": [{
            "type": "daily_restriction",
            "start_time_of_day": "08:00:00",
            "duration_seconds": 32400,
        }],
    }],
    teams=[example_team.id])

    package main

import (
	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := pagerduty.NewUser(ctx, "example", &pagerduty.UserArgs{
			Name:  pulumi.String("Earline Greenholt"),
			Email: pulumi.String("125.greenholt.earline@graham.name"),
		})
		if err != nil {
			return err
		}
		exampleTeam, err := pagerduty.NewTeam(ctx, "example", &pagerduty.TeamArgs{
			Name: pulumi.String("A Team"),
		})
		if err != nil {
			return err
		}
		_, err = pagerduty.NewSchedule(ctx, "foo", &pagerduty.ScheduleArgs{
			Name:     pulumi.String("Daily Engineering Rotation"),
			TimeZone: pulumi.String("America/New_York"),
			Layers: pagerduty.ScheduleLayerArray{
				&pagerduty.ScheduleLayerArgs{
					Name:                      pulumi.String("Night Shift"),
					Start:                     pulumi.String("2015-11-06T20:00:00-05:00"),
					RotationVirtualStart:      pulumi.String("2015-11-06T20:00:00-05:00"),
					RotationTurnLengthSeconds: pulumi.Int(86400),
					Users: pulumi.StringArray{
						example.ID(),
					},
					Restrictions: pagerduty.ScheduleLayerRestrictionArray{
						&pagerduty.ScheduleLayerRestrictionArgs{
							Type:            pulumi.String("daily_restriction"),
							StartTimeOfDay:  pulumi.String("08:00:00"),
							DurationSeconds: pulumi.Int(32400),
						},
					},
				},
			},
			Teams: pulumi.StringArray{
				exampleTeam.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

return await Deployment.RunAsync(() => 
{
    var example = new Pagerduty.User("example", new()
    {
        Name = "Earline Greenholt",
        Email = "125.greenholt.earline@graham.name",
    });

    var exampleTeam = new Pagerduty.Team("example", new()
    {
        Name = "A Team",
    });

    var foo = new Pagerduty.Schedule("foo", new()
    {
        Name = "Daily Engineering Rotation",
        TimeZone = "America/New_York",
        Layers = new[]
        {
            new Pagerduty.Inputs.ScheduleLayerArgs
            {
                Name = "Night Shift",
                Start = "2015-11-06T20:00:00-05:00",
                RotationVirtualStart = "2015-11-06T20:00:00-05:00",
                RotationTurnLengthSeconds = 86400,
                Users = new[]
                {
                    example.Id,
                },
                Restrictions = new[]
                {
                    new Pagerduty.Inputs.ScheduleLayerRestrictionArgs
                    {
                        Type = "daily_restriction",
                        StartTimeOfDay = "08:00:00",
                        DurationSeconds = 32400,
                    },
                },
            },
        },
        Teams = new[]
        {
            exampleTeam.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.User;
import com.pulumi.pagerduty.UserArgs;
import com.pulumi.pagerduty.Team;
import com.pulumi.pagerduty.TeamArgs;
import com.pulumi.pagerduty.Schedule;
import com.pulumi.pagerduty.ScheduleArgs;
import com.pulumi.pagerduty.inputs.ScheduleLayerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .name("Earline Greenholt")
            .email("125.greenholt.earline@graham.name")
            .build());

        var exampleTeam = new Team("exampleTeam", TeamArgs.builder()
            .name("A Team")
            .build());

        var foo = new Schedule("foo", ScheduleArgs.builder()
            .name("Daily Engineering Rotation")
            .timeZone("America/New_York")
            .layers(ScheduleLayerArgs.builder()
                .name("Night Shift")
                .start("2015-11-06T20:00:00-05:00")
                .rotationVirtualStart("2015-11-06T20:00:00-05:00")
                .rotationTurnLengthSeconds(86400)
                .users(example.id())
                .restrictions(ScheduleLayerRestrictionArgs.builder()
                    .type("daily_restriction")
                    .startTimeOfDay("08:00:00")
                    .durationSeconds(32400)
                    .build())
                .build())
            .teams(exampleTeam.id())
            .build());

    }
}

    resources:
  example:
    type: pagerduty:User
    properties:
      name: Earline Greenholt
      email: 125.greenholt.earline@graham.name
  exampleTeam:
    type: pagerduty:Team
    name: example
    properties:
      name: A Team
  foo:
    type: pagerduty:Schedule
    properties:
      name: Daily Engineering Rotation
      timeZone: America/New_York
      layers:
        - name: Night Shift
          start: 2015-11-06T20:00:00-05:00
          rotationVirtualStart: 2015-11-06T20:00:00-05:00
          rotationTurnLengthSeconds: 86400
          users:
            - ${example.id}
          restrictions:
            - type: daily_restriction
              startTimeOfDay: 08:00:00
              durationSeconds: 32400
      teams:
        - ${exampleTeam.id}

    Create Schedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
def Schedule(resource_name: str,
             args: ScheduleArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             layers: Optional[Sequence[ScheduleLayerArgs]] = None,
             time_zone: Optional[str] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             overflow: Optional[bool] = None,
             teams: Optional[Sequence[str]] = None)
    func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)
    public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)
    public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)

    type: pagerduty:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scheduleResource = new Pagerduty.Schedule("scheduleResource", new()
{
    Layers = new[]
    {
        new Pagerduty.Inputs.ScheduleLayerArgs
        {
            RotationTurnLengthSeconds = 0,
            RotationVirtualStart = "string",
            Start = "string",
            Users = new[]
            {
                "string",
            },
            End = "string",
            Id = "string",
            Name = "string",
            RenderedCoveragePercentage = "string",
            Restrictions = new[]
            {
                new Pagerduty.Inputs.ScheduleLayerRestrictionArgs
                {
                    DurationSeconds = 0,
                    StartTimeOfDay = "string",
                    Type = "string",
                    StartDayOfWeek = 0,
                },
            },
        },
    },
    TimeZone = "string",
    Description = "string",
    Name = "string",
    Overflow = false,
    Teams = new[]
    {
        "string",
    },
});

    example, err := pagerduty.NewSchedule(ctx, "scheduleResource", &pagerduty.ScheduleArgs{
	Layers: pagerduty.ScheduleLayerArray{
		&pagerduty.ScheduleLayerArgs{
			RotationTurnLengthSeconds: pulumi.Int(0),
			RotationVirtualStart:      pulumi.String("string"),
			Start:                     pulumi.String("string"),
			Users: pulumi.StringArray{
				pulumi.String("string"),
			},
			End:                        pulumi.String("string"),
			Id:                         pulumi.String("string"),
			Name:                       pulumi.String("string"),
			RenderedCoveragePercentage: pulumi.String("string"),
			Restrictions: pagerduty.ScheduleLayerRestrictionArray{
				&pagerduty.ScheduleLayerRestrictionArgs{
					DurationSeconds: pulumi.Int(0),
					StartTimeOfDay:  pulumi.String("string"),
					Type:            pulumi.String("string"),
					StartDayOfWeek:  pulumi.Int(0),
				},
			},
		},
	},
	TimeZone:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Overflow:    pulumi.Bool(false),
	Teams: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
    .layers(ScheduleLayerArgs.builder()
        .rotationTurnLengthSeconds(0)
        .rotationVirtualStart("string")
        .start("string")
        .users("string")
        .end("string")
        .id("string")
        .name("string")
        .renderedCoveragePercentage("string")
        .restrictions(ScheduleLayerRestrictionArgs.builder()
            .durationSeconds(0)
            .startTimeOfDay("string")
            .type("string")
            .startDayOfWeek(0)
            .build())
        .build())
    .timeZone("string")
    .description("string")
    .name("string")
    .overflow(false)
    .teams("string")
    .build());

    schedule_resource = pagerduty.Schedule("scheduleResource",
    layers=[{
        "rotation_turn_length_seconds": 0,
        "rotation_virtual_start": "string",
        "start": "string",
        "users": ["string"],
        "end": "string",
        "id": "string",
        "name": "string",
        "rendered_coverage_percentage": "string",
        "restrictions": [{
            "duration_seconds": 0,
            "start_time_of_day": "string",
            "type": "string",
            "start_day_of_week": 0,
        }],
    }],
    time_zone="string",
    description="string",
    name="string",
    overflow=False,
    teams=["string"])

    const scheduleResource = new pagerduty.Schedule("scheduleResource", {
    layers: [{
        rotationTurnLengthSeconds: 0,
        rotationVirtualStart: "string",
        start: "string",
        users: ["string"],
        end: "string",
        id: "string",
        name: "string",
        renderedCoveragePercentage: "string",
        restrictions: [{
            durationSeconds: 0,
            startTimeOfDay: "string",
            type: "string",
            startDayOfWeek: 0,
        }],
    }],
    timeZone: "string",
    description: "string",
    name: "string",
    overflow: false,
    teams: ["string"],
});

    type: pagerduty:Schedule
properties:
    description: string
    layers:
        - end: string
          id: string
          name: string
          renderedCoveragePercentage: string
          restrictions:
            - durationSeconds: 0
              startDayOfWeek: 0
              startTimeOfDay: string
              type: string
          rotationTurnLengthSeconds: 0
          rotationVirtualStart: string
          start: string
          users:
            - string
    name: string
    overflow: false
    teams:
        - string
    timeZone: string

    Schedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Schedule resource accepts the following input properties:

    Layers List<ScheduleLayer>
    A schedule layer block. Schedule layers documented below.
    TimeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    Description string
    The description of the schedule.
    Name string
    The name of the schedule.
    Overflow bool
    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.
    Teams List<string>
    Teams associated with the schedule.
    Layers []ScheduleLayerArgs
    A schedule layer block. Schedule layers documented below.
    TimeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    Description string
    The description of the schedule.
    Name string
    The name of the schedule.
    Overflow bool
    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.
    Teams []string
    Teams associated with the schedule.
    layers List<ScheduleLayer>
    A schedule layer block. Schedule layers documented below.
    timeZone String
    The time zone of the schedule (e.g. Europe/Berlin).
    description String
    The description of the schedule.
    name String
    The name of the schedule.
    overflow Boolean
    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.
    teams List<String>
    Teams associated with the schedule.
    layers ScheduleLayer[]
    A schedule layer block. Schedule layers documented below.
    timeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    description string
    The description of the schedule.
    name string
    The name of the schedule.
    overflow boolean
    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.
    teams string[]
    Teams associated with the schedule.
    layers Sequence[ScheduleLayerArgs]
    A schedule layer block. Schedule layers documented below.
    time_zone str
    The time zone of the schedule (e.g. Europe/Berlin).
    description str
    The description of the schedule.
    name str
    The name of the schedule.
    overflow bool
    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.
    teams Sequence[str]
    Teams associated with the schedule.
    layers List<Property Map>
    A schedule layer block. Schedule layers documented below.
    timeZone String
    The time zone of the schedule (e.g. Europe/Berlin).
    description String
    The description of the schedule.
    name String
    The name of the schedule.
    overflow Boolean
    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.
    teams List<String>
    Teams associated with the schedule.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:

    FinalSchedules List<ScheduleFinalSchedule>
    Id string
    The provider-assigned unique ID for this managed resource.
    FinalSchedules []ScheduleFinalSchedule
    Id string
    The provider-assigned unique ID for this managed resource.
    finalSchedules List<ScheduleFinalSchedule>
    id String
    The provider-assigned unique ID for this managed resource.
    finalSchedules ScheduleFinalSchedule[]
    id string
    The provider-assigned unique ID for this managed resource.
    final_schedules Sequence[ScheduleFinalSchedule]
    id str
    The provider-assigned unique ID for this managed resource.
    finalSchedules List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Schedule Resource

    Get an existing Schedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScheduleState, opts?: CustomResourceOptions): Schedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        final_schedules: Optional[Sequence[ScheduleFinalScheduleArgs]] = None,
        layers: Optional[Sequence[ScheduleLayerArgs]] = None,
        name: Optional[str] = None,
        overflow: Optional[bool] = None,
        teams: Optional[Sequence[str]] = None,
        time_zone: Optional[str] = None) -> Schedule
    func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)
    public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)
    public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the schedule.
    FinalSchedules List<ScheduleFinalSchedule>
    Layers List<ScheduleLayer>
    A schedule layer block. Schedule layers documented below.
    Name string
    The name of the schedule.
    Overflow bool
    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.
    Teams List<string>
    Teams associated with the schedule.
    TimeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    Description string
    The description of the schedule.
    FinalSchedules []ScheduleFinalScheduleArgs
    Layers []ScheduleLayerArgs
    A schedule layer block. Schedule layers documented below.
    Name string
    The name of the schedule.
    Overflow bool
    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.
    Teams []string
    Teams associated with the schedule.
    TimeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    description String
    The description of the schedule.
    finalSchedules List<ScheduleFinalSchedule>
    layers List<ScheduleLayer>
    A schedule layer block. Schedule layers documented below.
    name String
    The name of the schedule.
    overflow Boolean
    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.
    teams List<String>
    Teams associated with the schedule.
    timeZone String
    The time zone of the schedule (e.g. Europe/Berlin).
    description string
    The description of the schedule.
    finalSchedules ScheduleFinalSchedule[]
    layers ScheduleLayer[]
    A schedule layer block. Schedule layers documented below.
    name string
    The name of the schedule.
    overflow boolean
    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.
    teams string[]
    Teams associated with the schedule.
    timeZone string
    The time zone of the schedule (e.g. Europe/Berlin).
    description str
    The description of the schedule.
    final_schedules Sequence[ScheduleFinalScheduleArgs]
    layers Sequence[ScheduleLayerArgs]
    A schedule layer block. Schedule layers documented below.
    name str
    The name of the schedule.
    overflow bool
    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.
    teams Sequence[str]
    Teams associated with the schedule.
    time_zone str
    The time zone of the schedule (e.g. Europe/Berlin).
    description String
    The description of the schedule.
    finalSchedules List<Property Map>
    layers List<Property Map>
    A schedule layer block. Schedule layers documented below.
    name String
    The name of the schedule.
    overflow Boolean
    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.
    teams List<String>
    Teams associated with the schedule.
    timeZone String
    The time zone of the schedule (e.g. Europe/Berlin).

    Supporting Types

    ScheduleFinalSchedule, ScheduleFinalScheduleArgs

    Name string
    The name of the schedule.
    RenderedCoveragePercentage string
    Name string
    The name of the schedule.
    RenderedCoveragePercentage string
    name String
    The name of the schedule.
    renderedCoveragePercentage String
    name string
    The name of the schedule.
    renderedCoveragePercentage string
    name str
    The name of the schedule.
    rendered_coverage_percentage str
    name String
    The name of the schedule.
    renderedCoveragePercentage String

    ScheduleLayer, ScheduleLayerArgs

    RotationTurnLengthSeconds int
    The duration of each on-call shift in seconds.
    RotationVirtualStart string
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    Start string
    The start time of the schedule layer.
    Users List<string>
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    End string
    The end time of the schedule layer. If not specified, the layer does not end.
    Id string
    The ID of the schedule.
    Name string
    The name of the schedule layer.
    RenderedCoveragePercentage string
    Restrictions List<ScheduleLayerRestriction>
    A schedule layer restriction block. Restriction blocks documented below.
    RotationTurnLengthSeconds int
    The duration of each on-call shift in seconds.
    RotationVirtualStart string
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    Start string
    The start time of the schedule layer.
    Users []string
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    End string
    The end time of the schedule layer. If not specified, the layer does not end.
    Id string
    The ID of the schedule.
    Name string
    The name of the schedule layer.
    RenderedCoveragePercentage string
    Restrictions []ScheduleLayerRestriction
    A schedule layer restriction block. Restriction blocks documented below.
    rotationTurnLengthSeconds Integer
    The duration of each on-call shift in seconds.
    rotationVirtualStart String
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    start String
    The start time of the schedule layer.
    users List<String>
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    end String
    The end time of the schedule layer. If not specified, the layer does not end.
    id String
    The ID of the schedule.
    name String
    The name of the schedule layer.
    renderedCoveragePercentage String
    restrictions List<ScheduleLayerRestriction>
    A schedule layer restriction block. Restriction blocks documented below.
    rotationTurnLengthSeconds number
    The duration of each on-call shift in seconds.
    rotationVirtualStart string
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    start string
    The start time of the schedule layer.
    users string[]
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    end string
    The end time of the schedule layer. If not specified, the layer does not end.
    id string
    The ID of the schedule.
    name string
    The name of the schedule layer.
    renderedCoveragePercentage string
    restrictions ScheduleLayerRestriction[]
    A schedule layer restriction block. Restriction blocks documented below.
    rotation_turn_length_seconds int
    The duration of each on-call shift in seconds.
    rotation_virtual_start str
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    start str
    The start time of the schedule layer.
    users Sequence[str]
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    end str
    The end time of the schedule layer. If not specified, the layer does not end.
    id str
    The ID of the schedule.
    name str
    The name of the schedule layer.
    rendered_coverage_percentage str
    restrictions Sequence[ScheduleLayerRestriction]
    A schedule layer restriction block. Restriction blocks documented below.
    rotationTurnLengthSeconds Number
    The duration of each on-call shift in seconds.
    rotationVirtualStart String
    The effective start time of the schedule layer. This can be before the start time of the schedule.
    start String
    The start time of the schedule layer.
    users List<String>
    The ordered list of users on this layer. The position of the user on the list determines their order in the layer.
    end String
    The end time of the schedule layer. If not specified, the layer does not end.
    id String
    The ID of the schedule.
    name String
    The name of the schedule layer.
    renderedCoveragePercentage String
    restrictions List<Property Map>
    A schedule layer restriction block. Restriction blocks documented below.

    ScheduleLayerRestriction, ScheduleLayerRestrictionArgs

    DurationSeconds int
    The duration of the restriction in seconds.
    StartTimeOfDay string
    The start time in HH:mm:ss format.
    Type string
    Can be daily_restriction or weekly_restriction.
    StartDayOfWeek int
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.
    DurationSeconds int
    The duration of the restriction in seconds.
    StartTimeOfDay string
    The start time in HH:mm:ss format.
    Type string
    Can be daily_restriction or weekly_restriction.
    StartDayOfWeek int
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.
    durationSeconds Integer
    The duration of the restriction in seconds.
    startTimeOfDay String
    The start time in HH:mm:ss format.
    type String
    Can be daily_restriction or weekly_restriction.
    startDayOfWeek Integer
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.
    durationSeconds number
    The duration of the restriction in seconds.
    startTimeOfDay string
    The start time in HH:mm:ss format.
    type string
    Can be daily_restriction or weekly_restriction.
    startDayOfWeek number
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.
    duration_seconds int
    The duration of the restriction in seconds.
    start_time_of_day str
    The start time in HH:mm:ss format.
    type str
    Can be daily_restriction or weekly_restriction.
    start_day_of_week int
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.
    durationSeconds Number
    The duration of the restriction in seconds.
    startTimeOfDay String
    The start time in HH:mm:ss format.
    type String
    Can be daily_restriction or weekly_restriction.
    startDayOfWeek Number
    Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.

    Import

    Schedules can be imported using the id, e.g.

    $ pulumi import pagerduty:index/schedule:Schedule main PLBP09X

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-pagerduty