Grafana v0.7.0, Nov 5 24

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

grafana.OncallSchedule

Explore with Pulumi AI

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

Create OncallSchedule Resource

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

Constructor syntax

new OncallSchedule(name: string, args: OncallScheduleArgs, opts?: CustomResourceOptions);

@overload
def OncallSchedule(resource_name: str,
                   args: OncallScheduleArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def OncallSchedule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   enable_web_overrides: Optional[bool] = None,
                   ical_url_overrides: Optional[str] = None,
                   ical_url_primary: Optional[str] = None,
                   name: Optional[str] = None,
                   shifts: Optional[Sequence[str]] = None,
                   slack: Optional[OncallScheduleSlackArgs] = None,
                   team_id: Optional[str] = None,
                   time_zone: Optional[str] = None,
                   type: Optional[str] = None)

func NewOncallSchedule(ctx *Context, name string, args OncallScheduleArgs, opts ...ResourceOption) (*OncallSchedule, error)

public OncallSchedule(string name, OncallScheduleArgs args, CustomResourceOptions? opts = null)

public OncallSchedule(String name, OncallScheduleArgs args)
public OncallSchedule(String name, OncallScheduleArgs args, CustomResourceOptions options)

type: grafana:OncallSchedule
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 OncallScheduleArgs: 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 OncallScheduleArgs: 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 OncallScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OncallScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OncallScheduleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

OncallSchedule 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 OncallSchedule resource accepts the following input properties:

Type string: The schedule's type. Valid values are ical, calendar.
EnableWebOverrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
IcalUrlOverrides string: The URL of external iCal calendar which override primary events.
IcalUrlPrimary string: The URL of the external calendar iCal file.
Name string: The schedule's name.
Shifts List<string>: The list of ID's of on-call shifts.
Slack Pulumiverse.Grafana.Inputs.OncallScheduleSlack: The Slack-specific settings for a schedule.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
TimeZone string: The schedule's time zone.

Type string: The schedule's type. Valid values are ical, calendar.
EnableWebOverrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
IcalUrlOverrides string: The URL of external iCal calendar which override primary events.
IcalUrlPrimary string: The URL of the external calendar iCal file.
Name string: The schedule's name.
Shifts []string: The list of ID's of on-call shifts.
Slack OncallScheduleSlackArgs: The Slack-specific settings for a schedule.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
TimeZone string: The schedule's time zone.

type String: The schedule's type. Valid values are ical, calendar.
enableWebOverrides Boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides String: The URL of external iCal calendar which override primary events.
icalUrlPrimary String: The URL of the external calendar iCal file.
name String: The schedule's name.
shifts List<String>: The list of ID's of on-call shifts.
slack OncallScheduleSlack: The Slack-specific settings for a schedule.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone String: The schedule's time zone.

type string: The schedule's type. Valid values are ical, calendar.
enableWebOverrides boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides string: The URL of external iCal calendar which override primary events.
icalUrlPrimary string: The URL of the external calendar iCal file.
name string: The schedule's name.
shifts string[]: The list of ID's of on-call shifts.
slack OncallScheduleSlack: The Slack-specific settings for a schedule.
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone string: The schedule's time zone.

type str: The schedule's type. Valid values are ical, calendar.
enable_web_overrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
ical_url_overrides str: The URL of external iCal calendar which override primary events.
ical_url_primary str: The URL of the external calendar iCal file.
name str: The schedule's name.
shifts Sequence[str]: The list of ID's of on-call shifts.
slack OncallScheduleSlackArgs: The Slack-specific settings for a schedule.
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
time_zone str: The schedule's time zone.

type String: The schedule's type. Valid values are ical, calendar.
enableWebOverrides Boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides String: The URL of external iCal calendar which override primary events.
icalUrlPrimary String: The URL of the external calendar iCal file.
name String: The schedule's name.
shifts List<String>: The list of ID's of on-call shifts.
slack Property Map: The Slack-specific settings for a schedule.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone String: The schedule's time zone.

Outputs

All input properties are implicitly available as output properties. Additionally, the OncallSchedule 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 OncallSchedule Resource

Get an existing OncallSchedule 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?: OncallScheduleState, opts?: CustomResourceOptions): OncallSchedule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enable_web_overrides: Optional[bool] = None,
        ical_url_overrides: Optional[str] = None,
        ical_url_primary: Optional[str] = None,
        name: Optional[str] = None,
        shifts: Optional[Sequence[str]] = None,
        slack: Optional[OncallScheduleSlackArgs] = None,
        team_id: Optional[str] = None,
        time_zone: Optional[str] = None,
        type: Optional[str] = None) -> OncallSchedule

func GetOncallSchedule(ctx *Context, name string, id IDInput, state *OncallScheduleState, opts ...ResourceOption) (*OncallSchedule, error)

public static OncallSchedule Get(string name, Input<string> id, OncallScheduleState? state, CustomResourceOptions? opts = null)

public static OncallSchedule get(String name, Output<String> id, OncallScheduleState 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:

EnableWebOverrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
IcalUrlOverrides string: The URL of external iCal calendar which override primary events.
IcalUrlPrimary string: The URL of the external calendar iCal file.
Name string: The schedule's name.
Shifts List<string>: The list of ID's of on-call shifts.
Slack Pulumiverse.Grafana.Inputs.OncallScheduleSlack: The Slack-specific settings for a schedule.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
TimeZone string: The schedule's time zone.
Type string: The schedule's type. Valid values are ical, calendar.

EnableWebOverrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
IcalUrlOverrides string: The URL of external iCal calendar which override primary events.
IcalUrlPrimary string: The URL of the external calendar iCal file.
Name string: The schedule's name.
Shifts []string: The list of ID's of on-call shifts.
Slack OncallScheduleSlackArgs: The Slack-specific settings for a schedule.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
TimeZone string: The schedule's time zone.
Type string: The schedule's type. Valid values are ical, calendar.

enableWebOverrides Boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides String: The URL of external iCal calendar which override primary events.
icalUrlPrimary String: The URL of the external calendar iCal file.
name String: The schedule's name.
shifts List<String>: The list of ID's of on-call shifts.
slack OncallScheduleSlack: The Slack-specific settings for a schedule.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone String: The schedule's time zone.
type String: The schedule's type. Valid values are ical, calendar.

enableWebOverrides boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides string: The URL of external iCal calendar which override primary events.
icalUrlPrimary string: The URL of the external calendar iCal file.
name string: The schedule's name.
shifts string[]: The list of ID's of on-call shifts.
slack OncallScheduleSlack: The Slack-specific settings for a schedule.
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone string: The schedule's time zone.
type string: The schedule's type. Valid values are ical, calendar.

enable_web_overrides bool: Enable overrides via web UI (it will ignore icalurloverrides).
ical_url_overrides str: The URL of external iCal calendar which override primary events.
ical_url_primary str: The URL of the external calendar iCal file.
name str: The schedule's name.
shifts Sequence[str]: The list of ID's of on-call shifts.
slack OncallScheduleSlackArgs: The Slack-specific settings for a schedule.
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
time_zone str: The schedule's time zone.
type str: The schedule's type. Valid values are ical, calendar.

enableWebOverrides Boolean: Enable overrides via web UI (it will ignore icalurloverrides).
icalUrlOverrides String: The URL of external iCal calendar which override primary events.
icalUrlPrimary String: The URL of the external calendar iCal file.
name String: The schedule's name.
shifts List<String>: The list of ID's of on-call shifts.
slack Property Map: The Slack-specific settings for a schedule.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.onCall.getTeam datasource.
timeZone String: The schedule's time zone.
type String: The schedule's type. Valid values are ical, calendar.

Supporting Types

OncallScheduleSlack, OncallScheduleSlackArgs

ChannelId string: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
UserGroupId string: Slack user group id. Members of user group will be updated when on-call users change.

ChannelId string: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
UserGroupId string: Slack user group id. Members of user group will be updated when on-call users change.

channelId String: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
userGroupId String: Slack user group id. Members of user group will be updated when on-call users change.

channelId string: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
userGroupId string: Slack user group id. Members of user group will be updated when on-call users change.

channel_id str: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
user_group_id str: Slack user group id. Members of user group will be updated when on-call users change.

channelId String: Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
userGroupId String: Slack user group id. Members of user group will be updated when on-call users change.

Import

$ pulumi import grafana:index/oncallSchedule:OncallSchedule name "{{ id }}"

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

Package Details

Repository: grafana pulumiverse/pulumi-grafana
License: Apache-2.0
Notes: This Pulumi package is based on the grafana Terraform Provider.

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

pulumiverse/pulumi-grafana

grafana.OncallSchedule

On this page

On this page

Create OncallSchedule Resource

Constructor syntax

Parameters

OncallSchedule Resource Properties

Inputs

Outputs

Look up Existing OncallSchedule Resource

Supporting Types

OncallScheduleSlack, OncallScheduleSlackArgs

Import

Package Details

On this page

On this page