Fork me on GitHub

Module timer

@pulumi/cloud

Index

timer/index.ts

Modules

function cron

cron(name: string, cronTab: string, handler: Action, opts?: pulumi.ResourceOptions): void

A cron timer, which fires on based on a specificied cron schedule.

function daily

daily(name: string, handler: Action, opts?: pulumi.ResourceOptions): void

A daily timer, firing each day, on the day (at UTC midnight).

daily(name: string, schedule: DailySchedule, handler: Action, opts?: pulumi.ResourceOptions): void

A daily timer, firing at the specified UTC hour and minute each day.

function hourly

hourly(name: string, handler: Action, opts?: pulumi.ResourceOptions): void

An hourly timer, firing each hour, on the hour.

hourly(name: string, schedule: HourlySchedule, handler: Action, opts?: pulumi.ResourceOptions): void

An hourly timer, firing at the specified UTC minute each hour.

function interval

interval(name: string, options: IntervalRate, handler: Action, opts?: pulumi.ResourceOptions): void

An interval timer, which fires on a regular time interval.

interface DailySchedule

DailySchedule describes a time of day ([[hourUTC]] and [[minuteUTC]]) at which a daily timer should fire.

property hourUTC

hourUTC?: undefined | number;

The hour, in UTC, that the timer should fire.

property minuteUTC

minuteUTC?: undefined | number;

The minute, in UTC, that the timer should fire.

interface HourlySchedule

HourlySchedule describes a time of the hour ([[minuteUTC]]) at which an hourly timer should fire.

property minuteUTC

minuteUTC?: undefined | number;

The minute, in UTC, that the timer should fire.

interface IntervalRate

IntervalRate describes the rate at which a timer will fire.

At least one of [[minutes]], [[hours]] or [[days]] must be provided.

property days

days?: undefined | number;

The number of days in the interval. Must be a positive integer.

property hours

hours?: undefined | number;

The number of hours in the interval. Must be a positive integer.

property minutes

minutes?: undefined | number;

The number of minutes in the interval. Must be a positive integer.

type Action

type Action = { ... };

Action is a handler that performs an action in response to a timer firing.