1. Packages
  2. Opsgenie Provider
  3. API Docs
  4. Schedule
Opsgenie v1.3.14 published on Wednesday, Feb 12, 2025 by Pulumi

opsgenie.Schedule

Explore with Pulumi AI

Manages a Schedule within Opsgenie.

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: Optional[ScheduleArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             enabled: Optional[bool] = None,
             name: Optional[str] = None,
             owner_team_id: Optional[str] = None,
             timezone: Optional[str] = None)
func NewSchedule(ctx *Context, name string, args *ScheduleArgs, opts ...ResourceOption) (*Schedule, error)
public Schedule(string name, ScheduleArgs? args = null, CustomResourceOptions? opts = null)
public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)
type: opsgenie:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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 Opsgenie.Schedule("scheduleResource", new()
{
    Description = "string",
    Enabled = false,
    Name = "string",
    OwnerTeamId = "string",
    Timezone = "string",
});
Copy
example, err := opsgenie.NewSchedule(ctx, "scheduleResource", &opsgenie.ScheduleArgs{
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	OwnerTeamId: pulumi.String("string"),
	Timezone:    pulumi.String("string"),
})
Copy
var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
    .description("string")
    .enabled(false)
    .name("string")
    .ownerTeamId("string")
    .timezone("string")
    .build());
Copy
schedule_resource = opsgenie.Schedule("scheduleResource",
    description="string",
    enabled=False,
    name="string",
    owner_team_id="string",
    timezone="string")
Copy
const scheduleResource = new opsgenie.Schedule("scheduleResource", {
    description: "string",
    enabled: false,
    name: "string",
    ownerTeamId: "string",
    timezone: "string",
});
Copy
type: opsgenie:Schedule
properties:
    description: string
    enabled: false
    name: string
    ownerTeamId: string
    timezone: string
Copy

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:

Description string
The description of schedule.
Enabled bool
Enable/disable state of schedule
Name string
Name of the schedule.
OwnerTeamId string
Owner team id of the schedule.
Timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
Description string
The description of schedule.
Enabled bool
Enable/disable state of schedule
Name string
Name of the schedule.
OwnerTeamId string
Owner team id of the schedule.
Timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description String
The description of schedule.
enabled Boolean
Enable/disable state of schedule
name String
Name of the schedule.
ownerTeamId String
Owner team id of the schedule.
timezone String
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description string
The description of schedule.
enabled boolean
Enable/disable state of schedule
name string
Name of the schedule.
ownerTeamId string
Owner team id of the schedule.
timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description str
The description of schedule.
enabled bool
Enable/disable state of schedule
name str
Name of the schedule.
owner_team_id str
Owner team id of the schedule.
timezone str
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description String
The description of schedule.
enabled Boolean
Enable/disable state of schedule
name String
Name of the schedule.
ownerTeamId String
Owner team id of the schedule.
timezone String
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
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,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        owner_team_id: Optional[str] = None,
        timezone: 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)
resources:  _:    type: opsgenie:Schedule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 schedule.
Enabled bool
Enable/disable state of schedule
Name string
Name of the schedule.
OwnerTeamId string
Owner team id of the schedule.
Timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
Description string
The description of schedule.
Enabled bool
Enable/disable state of schedule
Name string
Name of the schedule.
OwnerTeamId string
Owner team id of the schedule.
Timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description String
The description of schedule.
enabled Boolean
Enable/disable state of schedule
name String
Name of the schedule.
ownerTeamId String
Owner team id of the schedule.
timezone String
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description string
The description of schedule.
enabled boolean
Enable/disable state of schedule
name string
Name of the schedule.
ownerTeamId string
Owner team id of the schedule.
timezone string
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description str
The description of schedule.
enabled bool
Enable/disable state of schedule
name str
Name of the schedule.
owner_team_id str
Owner team id of the schedule.
timezone str
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.
description String
The description of schedule.
enabled Boolean
Enable/disable state of schedule
name String
Name of the schedule.
ownerTeamId String
Owner team id of the schedule.
timezone String
Timezone of schedule. Please look at Supported Timezone Ids for available timezones - Default: America/New_York.

Import

Schedule can be imported using the schedule_id, e.g.

$ pulumi import opsgenie:index/schedule:Schedule test schedule_id`
Copy

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

Package Details

Repository
Opsgenie pulumi/pulumi-opsgenie
License
Apache-2.0
Notes
This Pulumi package is based on the opsgenie Terraform Provider.