How to trigger custom function on lifecycle events?

Question

How do I instruct Pulumi to invoke my custom Typescript function when pulumi up or pulumi destroy is invoked from command-line?

I tried invoking my function from the main code block, but it is getting invoked multiple times on pulumi up.

Further, there are some commands I only want to invoke for up and others that should only be invoked for destroy.

score 1 · Accepted Answer · answered Aug 29 '19 at 19:05

1

You can use pulumi.runtime.isDryRun() to run code or functions only during update. Pulumi doesn't currently expose a way to hook into lifecycle events, but this is on the roadmap at https://github.com/pulumi/pulumi/issues/1691.

answered Aug 29 '19 at 19:05

Cameron

431
3
3

score 0 · Answer 2 · answered Aug 31 '21 at 11:24

If you are ok with this function to be called async you can wrap your stack using Pulumi Automation API and provide onEvent option when invoking it using TypeScript:

stack.up({
  onEvent: (event) => {
    if (event["preludeEvent"] !== undefined) {
      // run something once before changing resources
      return
    }
  },
})

The same can be done during destory

github.com - more details on what types of events are available.
dev.to - detailed blog about using pulumi automation events

How to trigger custom function on lifecycle events?

2 Answers2