Resource Heartbeat in pulumi-better-uptime.
Pulumi type: better-uptime:index/heartbeat:Heartbeat.
name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.
Example#
Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.
Arguments#
| Property | Type | Required | Description |
|---|---|---|---|
call | boolean | no | Whether to call when a new incident is created. |
criticalAlert | boolean | no | Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created. |
email | boolean | no | Whether to send an email when a new incident is created. |
grace | number | yes | Heartbeats can fluctuate; specify this value to control what is still acceptable. Minimum value: 0 seconds. We recommend setting this to approx. 20% of period |
heartbeatGroupId | number | no | Set this attribute if you want to add this heartbeat to a heartbeat group.. |
maintenanceDays | string[] | no | An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] or any subset of these days. |
maintenanceFrom | string | no | Start of the maintenance window each day. We won't create incidents during this window. Example: "01:00:00" |
maintenanceTimezone | string | no | The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html |
maintenanceTo | string | no | End of the maintenance window each day. Example: "03:00:00" |
name | string | no | A name of the service for this heartbeat. |
paused | boolean | no | Set to true to pause monitoring — we won't notify you about downtime. Set to false to resume monitoring. |
period | number | yes | How often should we expect this heartbeat? In seconds. Minimum value: 30 seconds |
policyId | string | no | Set the escalation policy for the heartbeat. |
push | boolean | no | Whether to send a push notification when a new incident is created. |
serverTimezone | string | no | The IANA timezone (e.g. "Europe/Berlin") used to evaluate this heartbeat's period against wall-clock time, keeping daily and cron-style schedules aligned across daylight saving time changes. Only applies to periods of 1 hour or longer; it is cleared for shorter periods. |
sms | boolean | no | Whether to send an SMS when a new incident is created. |
sortIndex | number | no | An index controlling the position of a heartbeat in the heartbeat group. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
teamWait | number | no | How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. |
Outputs#
Computed outputs are produced by the provider. They are not constructor arguments.
| Property | Type | Computed | Description |
|---|---|---|---|
call | boolean | no | Whether to call when a new incident is created. |
createdAt | string | yes | The time when this heartbeat was created. |
criticalAlert | boolean | no | Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created. |
email | boolean | no | Whether to send an email when a new incident is created. |
grace | number | no | Heartbeats can fluctuate; specify this value to control what is still acceptable. Minimum value: 0 seconds. We recommend setting this to approx. 20% of period |
heartbeatGroupId | number | no | Set this attribute if you want to add this heartbeat to a heartbeat group.. |
maintenanceDays | string[] | no | An array of maintenance days to set. If a maintenance window is overnight both affected days should be set. Allowed values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] or any subset of these days. |
maintenanceFrom | string | no | Start of the maintenance window each day. We won't create incidents during this window. Example: "01:00:00" |
maintenanceTimezone | string | no | The timezone to use for the maintenance window each day. Defaults to UTC. The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html |
maintenanceTo | string | no | End of the maintenance window each day. Example: "03:00:00" |
name | string | no | A name of the service for this heartbeat. |
paused | boolean | no | Set to true to pause monitoring — we won't notify you about downtime. Set to false to resume monitoring. |
pausedAt | string | yes | The time when this heartbeat was paused. |
period | number | no | How often should we expect this heartbeat? In seconds. Minimum value: 30 seconds |
policyId | string | no | Set the escalation policy for the heartbeat. |
push | boolean | no | Whether to send a push notification when a new incident is created. |
serverTimezone | string | no | The IANA timezone (e.g. "Europe/Berlin") used to evaluate this heartbeat's period against wall-clock time, keeping daily and cron-style schedules aligned across daylight saving time changes. Only applies to periods of 1 hour or longer; it is cleared for shorter periods. |
sms | boolean | no | Whether to send an SMS when a new incident is created. |
sortIndex | number | no | An index controlling the position of a heartbeat in the heartbeat group. |
status | string | yes | The status of this heartbeat. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
teamWait | number | no | How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. |
updatedAt | string | yes | The time when this heartbeat was updated. |
url | string | yes | The url of this heartbeat. |