Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
grafana.OncallSchedule
Explore with Pulumi AI
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,
type: Optional[str] = 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)
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.
Example
The following reference example uses placeholder values for all input properties.
var oncallScheduleResource = new Grafana.OncallSchedule("oncallScheduleResource", new()
{
Type = "string",
EnableWebOverrides = false,
IcalUrlOverrides = "string",
IcalUrlPrimary = "string",
Name = "string",
Shifts = new[]
{
"string",
},
Slack = new Grafana.Inputs.OncallScheduleSlackArgs
{
ChannelId = "string",
UserGroupId = "string",
},
TeamId = "string",
TimeZone = "string",
});
example, err := grafana.NewOncallSchedule(ctx, "oncallScheduleResource", &grafana.OncallScheduleArgs{
Type: pulumi.String("string"),
EnableWebOverrides: pulumi.Bool(false),
IcalUrlOverrides: pulumi.String("string"),
IcalUrlPrimary: pulumi.String("string"),
Name: pulumi.String("string"),
Shifts: pulumi.StringArray{
pulumi.String("string"),
},
Slack: &grafana.OncallScheduleSlackArgs{
ChannelId: pulumi.String("string"),
UserGroupId: pulumi.String("string"),
},
TeamId: pulumi.String("string"),
TimeZone: pulumi.String("string"),
})
var oncallScheduleResource = new OncallSchedule("oncallScheduleResource", OncallScheduleArgs.builder()
.type("string")
.enableWebOverrides(false)
.icalUrlOverrides("string")
.icalUrlPrimary("string")
.name("string")
.shifts("string")
.slack(OncallScheduleSlackArgs.builder()
.channelId("string")
.userGroupId("string")
.build())
.teamId("string")
.timeZone("string")
.build());
oncall_schedule_resource = grafana.OncallSchedule("oncallScheduleResource",
type="string",
enable_web_overrides=False,
ical_url_overrides="string",
ical_url_primary="string",
name="string",
shifts=["string"],
slack=grafana.OncallScheduleSlackArgs(
channel_id="string",
user_group_id="string",
),
team_id="string",
time_zone="string")
const oncallScheduleResource = new grafana.OncallSchedule("oncallScheduleResource", {
type: "string",
enableWebOverrides: false,
icalUrlOverrides: "string",
icalUrlPrimary: "string",
name: "string",
shifts: ["string"],
slack: {
channelId: "string",
userGroupId: "string",
},
teamId: "string",
timeZone: "string",
});
type: grafana:OncallSchedule
properties:
enableWebOverrides: false
icalUrlOverrides: string
icalUrlPrimary: string
name: string
shifts:
- string
slack:
channelId: string
userGroupId: string
teamId: string
timeZone: string
type: string
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
The OncallSchedule resource accepts the following input properties:
- Type string
- The schedule's type.
- Enable
Web boolOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- Ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- Ical
Url stringPrimary - 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. Oncall Schedule Slack - The Slack-specific settings for a schedule.
- Team
Id 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_team
datasource. - Time
Zone string - The schedule's time zone.
- Type string
- The schedule's type.
- Enable
Web boolOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- Ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- Ical
Url stringPrimary - 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
Oncall
Schedule Slack Args - The Slack-specific settings for a schedule.
- Team
Id 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_team
datasource. - Time
Zone string - The schedule's time zone.
- type String
- The schedule's type.
- enable
Web BooleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url StringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url StringPrimary - 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
Oncall
Schedule Slack - The Slack-specific settings for a schedule.
- team
Id 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_team
datasource. - time
Zone String - The schedule's time zone.
- type string
- The schedule's type.
- enable
Web booleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url stringPrimary - 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
Oncall
Schedule Slack - The Slack-specific settings for a schedule.
- team
Id 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_team
datasource. - time
Zone string - The schedule's time zone.
- type str
- The schedule's type.
- enable_
web_ booloverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical_
url_ stroverrides - The URL of external iCal calendar which override primary events.
- ical_
url_ strprimary - 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
Oncall
Schedule Slack Args - 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_team
datasource. - time_
zone str - The schedule's time zone.
- type String
- The schedule's type.
- enable
Web BooleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url StringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url StringPrimary - 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.
- team
Id 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_team
datasource. - time
Zone 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.
- Enable
Web boolOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- Ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- Ical
Url stringPrimary - 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. Oncall Schedule Slack - The Slack-specific settings for a schedule.
- Team
Id 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_team
datasource. - Time
Zone string - The schedule's time zone.
- Type string
- The schedule's type.
- Enable
Web boolOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- Ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- Ical
Url stringPrimary - 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
Oncall
Schedule Slack Args - The Slack-specific settings for a schedule.
- Team
Id 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_team
datasource. - Time
Zone string - The schedule's time zone.
- Type string
- The schedule's type.
- enable
Web BooleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url StringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url StringPrimary - 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
Oncall
Schedule Slack - The Slack-specific settings for a schedule.
- team
Id 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_team
datasource. - time
Zone String - The schedule's time zone.
- type String
- The schedule's type.
- enable
Web booleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url stringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url stringPrimary - 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
Oncall
Schedule Slack - The Slack-specific settings for a schedule.
- team
Id 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_team
datasource. - time
Zone string - The schedule's time zone.
- type string
- The schedule's type.
- enable_
web_ booloverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical_
url_ stroverrides - The URL of external iCal calendar which override primary events.
- ical_
url_ strprimary - 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
Oncall
Schedule Slack Args - 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_team
datasource. - time_
zone str - The schedule's time zone.
- type str
- The schedule's type.
- enable
Web BooleanOverrides - Enable overrides via web UI (it will ignore ical_url_overrides).
- ical
Url StringOverrides - The URL of external iCal calendar which override primary events.
- ical
Url StringPrimary - 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.
- team
Id 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_team
datasource. - time
Zone String - The schedule's time zone.
- type String
- The schedule's type.
Supporting Types
OncallScheduleSlack, OncallScheduleSlackArgs
- Channel
Id string - Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
- User
Group stringId - Slack user group id. Members of user group will be updated when on-call users change.
- Channel
Id string - Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
- User
Group stringId - Slack user group id. Members of user group will be updated when on-call users change.
- channel
Id String - Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
- user
Group StringId - Slack user group id. Members of user group will be updated when on-call users change.
- channel
Id string - Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
- user
Group stringId - 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_ strid - Slack user group id. Members of user group will be updated when on-call users change.
- channel
Id String - Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack.
- user
Group StringId - Slack user group id. Members of user group will be updated when on-call users change.
Package Details
- Repository
- grafana pulumiverse/pulumi-grafana
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
grafana
Terraform Provider.