aws-cdk-lib.triggers.TriggerOptions

TriggerOptions Struct

Options for Trigger.

Source

triggers/lib/trigger.ts

Type last changed

v2.15.0 · 1 Mar 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { triggers } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
const triggerOptions: triggers.TriggerOptions = {
  executeAfter: [construct],
  executeBefore: [construct],
  executeOnHandlerChange: false,
};

Properties

executeAfter?optionalConstruct[]execute_after?optionaltyping.List[Construct]executeAfter?optionalList<Construct>ExecuteAfter?optionalConstruct[]ExecuteAfter?optional*[]Construct= []#

Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned.

You can also use trigger.executeAfter() to add additional dependencies.

executeBefore?optionalConstruct[]execute_before?optionaltyping.List[Construct]executeBefore?optionalList<Construct>ExecuteBefore?optionalConstruct[]ExecuteBefore?optional*[]Construct= []#

Adds this trigger as a dependency on other constructs.

This means that this trigger will get executed before the given construct(s).

You can also use trigger.executeBefore() to add additional dependents.

executeOnHandlerChange?optionalbooleanexecute_on_handler_change?optionalboolexecuteOnHandlerChange?optionalBooleanExecuteOnHandlerChange?optionalboolExecuteOnHandlerChange?optional*bool= true#

Re-executes the trigger every time the handler changes.

This implies that the trigger is associated with the currentVersion of the handler, which gets recreated every time the handler or its configuration is updated.