grafana.OncallOnCallShift
Explore with Pulumi AI
Create OncallOnCallShift Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OncallOnCallShift(name: string, args: OncallOnCallShiftArgs, opts?: CustomResourceOptions);
@overload
def OncallOnCallShift(resource_name: str,
args: OncallOnCallShiftArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OncallOnCallShift(resource_name: str,
opts: Optional[ResourceOptions] = None,
by_days: Optional[Sequence[str]] = None,
by_monthdays: Optional[Sequence[int]] = None,
by_months: Optional[Sequence[int]] = None,
duration: Optional[int] = None,
frequency: Optional[str] = None,
interval: Optional[int] = None,
level: Optional[int] = None,
name: Optional[str] = None,
rolling_users: Optional[Sequence[Sequence[str]]] = None,
start: Optional[str] = None,
start_rotation_from_user_index: Optional[int] = None,
team_id: Optional[str] = None,
time_zone: Optional[str] = None,
type: Optional[str] = None,
users: Optional[Sequence[str]] = None,
week_start: Optional[str] = None)
func NewOncallOnCallShift(ctx *Context, name string, args OncallOnCallShiftArgs, opts ...ResourceOption) (*OncallOnCallShift, error)
public OncallOnCallShift(string name, OncallOnCallShiftArgs args, CustomResourceOptions? opts = null)
public OncallOnCallShift(String name, OncallOnCallShiftArgs args)
public OncallOnCallShift(String name, OncallOnCallShiftArgs args, CustomResourceOptions options)
type: grafana:OncallOnCallShift
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 OncallOnCallShiftArgs
- 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 OncallOnCallShiftArgs
- 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 OncallOnCallShiftArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OncallOnCallShiftArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OncallOnCallShiftArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
OncallOnCallShift 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 OncallOnCallShift resource accepts the following input properties:
- Duration int
- The duration of the event.
- Start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- Type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- By
Days List<string> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- By
Monthdays List<int> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- By
Months List<int> - This parameter takes a list of months. Valid values are 1 to 12
- Frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- Interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- Level int
- The priority level. The higher the value, the higher the priority.
- Name string
- The shift's name.
- Rolling
Users List<ImmutableArray<string>> - The list of lists with on-call users (for rolling_users event type)
- Start
Rotation intFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - Time
Zone string - The shift's timezone. Overrides schedule's timezone.
- Users List<string>
- The list of on-call users (for singleevent and recurrentevent event type).
- Week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- Duration int
- The duration of the event.
- Start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- Type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- By
Days []string - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- By
Monthdays []int - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- By
Months []int - This parameter takes a list of months. Valid values are 1 to 12
- Frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- Interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- Level int
- The priority level. The higher the value, the higher the priority.
- Name string
- The shift's name.
- Rolling
Users [][]string - The list of lists with on-call users (for rolling_users event type)
- Start
Rotation intFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - Time
Zone string - The shift's timezone. Overrides schedule's timezone.
- Users []string
- The list of on-call users (for singleevent and recurrentevent event type).
- Week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- duration Integer
- The duration of the event.
- start String
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- type String
- The shift's type. Can be rollingusers, recurrentevent, single_event
- by
Days List<String> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays List<Integer> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months List<Integer> - This parameter takes a list of months. Valid values are 1 to 12
- frequency String
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval Integer
- The positive integer representing at which intervals the recurrence rule repeats.
- level Integer
- The priority level. The higher the value, the higher the priority.
- name String
- The shift's name.
- rolling
Users List<List<String>> - The list of lists with on-call users (for rolling_users event type)
- start
Rotation IntegerFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone String - The shift's timezone. Overrides schedule's timezone.
- users List<String>
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start String - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- duration number
- The duration of the event.
- start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- by
Days string[] - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays number[] - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months number[] - This parameter takes a list of months. Valid values are 1 to 12
- frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval number
- The positive integer representing at which intervals the recurrence rule repeats.
- level number
- The priority level. The higher the value, the higher the priority.
- name string
- The shift's name.
- rolling
Users string[][] - The list of lists with on-call users (for rolling_users event type)
- start
Rotation numberFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone string - The shift's timezone. Overrides schedule's timezone.
- users string[]
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- duration int
- The duration of the event.
- start str
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- type str
- The shift's type. Can be rollingusers, recurrentevent, single_event
- by_
days Sequence[str] - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by_
monthdays Sequence[int] - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by_
months Sequence[int] - This parameter takes a list of months. Valid values are 1 to 12
- frequency str
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- level int
- The priority level. The higher the value, the higher the priority.
- name str
- The shift's name.
- rolling_
users Sequence[Sequence[str]] - The list of lists with on-call users (for rolling_users event type)
- start_
rotation_ intfrom_ user_ index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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 shift's timezone. Overrides schedule's timezone.
- users Sequence[str]
- The list of on-call users (for singleevent and recurrentevent event type).
- week_
start str - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- duration Number
- The duration of the event.
- start String
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- type String
- The shift's type. Can be rollingusers, recurrentevent, single_event
- by
Days List<String> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays List<Number> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months List<Number> - This parameter takes a list of months. Valid values are 1 to 12
- frequency String
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval Number
- The positive integer representing at which intervals the recurrence rule repeats.
- level Number
- The priority level. The higher the value, the higher the priority.
- name String
- The shift's name.
- rolling
Users List<List<String>> - The list of lists with on-call users (for rolling_users event type)
- start
Rotation NumberFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone String - The shift's timezone. Overrides schedule's timezone.
- users List<String>
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start String - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
Outputs
All input properties are implicitly available as output properties. Additionally, the OncallOnCallShift 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 OncallOnCallShift Resource
Get an existing OncallOnCallShift 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?: OncallOnCallShiftState, opts?: CustomResourceOptions): OncallOnCallShift
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
by_days: Optional[Sequence[str]] = None,
by_monthdays: Optional[Sequence[int]] = None,
by_months: Optional[Sequence[int]] = None,
duration: Optional[int] = None,
frequency: Optional[str] = None,
interval: Optional[int] = None,
level: Optional[int] = None,
name: Optional[str] = None,
rolling_users: Optional[Sequence[Sequence[str]]] = None,
start: Optional[str] = None,
start_rotation_from_user_index: Optional[int] = None,
team_id: Optional[str] = None,
time_zone: Optional[str] = None,
type: Optional[str] = None,
users: Optional[Sequence[str]] = None,
week_start: Optional[str] = None) -> OncallOnCallShift
func GetOncallOnCallShift(ctx *Context, name string, id IDInput, state *OncallOnCallShiftState, opts ...ResourceOption) (*OncallOnCallShift, error)
public static OncallOnCallShift Get(string name, Input<string> id, OncallOnCallShiftState? state, CustomResourceOptions? opts = null)
public static OncallOnCallShift get(String name, Output<String> id, OncallOnCallShiftState 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.
- By
Days List<string> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- By
Monthdays List<int> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- By
Months List<int> - This parameter takes a list of months. Valid values are 1 to 12
- Duration int
- The duration of the event.
- Frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- Interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- Level int
- The priority level. The higher the value, the higher the priority.
- Name string
- The shift's name.
- Rolling
Users List<ImmutableArray<string>> - The list of lists with on-call users (for rolling_users event type)
- Start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- Start
Rotation intFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - Time
Zone string - The shift's timezone. Overrides schedule's timezone.
- Type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- Users List<string>
- The list of on-call users (for singleevent and recurrentevent event type).
- Week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- By
Days []string - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- By
Monthdays []int - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- By
Months []int - This parameter takes a list of months. Valid values are 1 to 12
- Duration int
- The duration of the event.
- Frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- Interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- Level int
- The priority level. The higher the value, the higher the priority.
- Name string
- The shift's name.
- Rolling
Users [][]string - The list of lists with on-call users (for rolling_users event type)
- Start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- Start
Rotation intFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - Time
Zone string - The shift's timezone. Overrides schedule's timezone.
- Type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- Users []string
- The list of on-call users (for singleevent and recurrentevent event type).
- Week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Days List<String> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays List<Integer> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months List<Integer> - This parameter takes a list of months. Valid values are 1 to 12
- duration Integer
- The duration of the event.
- frequency String
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval Integer
- The positive integer representing at which intervals the recurrence rule repeats.
- level Integer
- The priority level. The higher the value, the higher the priority.
- name String
- The shift's name.
- rolling
Users List<List<String>> - The list of lists with on-call users (for rolling_users event type)
- start String
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- start
Rotation IntegerFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone String - The shift's timezone. Overrides schedule's timezone.
- type String
- The shift's type. Can be rollingusers, recurrentevent, single_event
- users List<String>
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start String - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Days string[] - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays number[] - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months number[] - This parameter takes a list of months. Valid values are 1 to 12
- duration number
- The duration of the event.
- frequency string
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval number
- The positive integer representing at which intervals the recurrence rule repeats.
- level number
- The priority level. The higher the value, the higher the priority.
- name string
- The shift's name.
- rolling
Users string[][] - The list of lists with on-call users (for rolling_users event type)
- start string
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- start
Rotation numberFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone string - The shift's timezone. Overrides schedule's timezone.
- type string
- The shift's type. Can be rollingusers, recurrentevent, single_event
- users string[]
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start string - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by_
days Sequence[str] - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by_
monthdays Sequence[int] - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by_
months Sequence[int] - This parameter takes a list of months. Valid values are 1 to 12
- duration int
- The duration of the event.
- frequency str
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval int
- The positive integer representing at which intervals the recurrence rule repeats.
- level int
- The priority level. The higher the value, the higher the priority.
- name str
- The shift's name.
- rolling_
users Sequence[Sequence[str]] - The list of lists with on-call users (for rolling_users event type)
- start str
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- start_
rotation_ intfrom_ user_ index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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 shift's timezone. Overrides schedule's timezone.
- type str
- The shift's type. Can be rollingusers, recurrentevent, single_event
- users Sequence[str]
- The list of on-call users (for singleevent and recurrentevent event type).
- week_
start str - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Days List<String> - This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
- by
Monthdays List<Number> - This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
- by
Months List<Number> - This parameter takes a list of months. Valid values are 1 to 12
- duration Number
- The duration of the event.
- frequency String
- The frequency of the event. Can be hourly, daily, weekly, monthly
- interval Number
- The positive integer representing at which intervals the recurrence rule repeats.
- level Number
- The priority level. The higher the value, the higher the priority.
- name String
- The shift's name.
- rolling
Users List<List<String>> - The list of lists with on-call users (for rolling_users event type)
- start String
- The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
- start
Rotation NumberFrom User Index - The index of the list of users in rolling_users, from which on-call rotation starts.
- 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.getTeam
datasource. - time
Zone String - The shift's timezone. Overrides schedule's timezone.
- type String
- The shift's type. Can be rollingusers, recurrentevent, single_event
- users List<String>
- The list of on-call users (for singleevent and recurrentevent event type).
- week
Start String - Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
Import
$ pulumi import grafana:index/oncallOnCallShift:OncallOnCallShift 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.