class Trigger (construct)

Language	Type name
.NET	Amazon.CDK.Triggers.Trigger
Java	software.amazon.awscdk.triggers.Trigger
Python	aws_cdk.triggers.Trigger
TypeScript (source)	@aws-cdk/triggers » Trigger

Implements IConstruct, IConstruct, IDependable, ITrigger

Triggers an AWS Lambda function during deployment.

Example

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

declare const construct: constructs.Construct;
declare const function_: lambda.Function;
const trigger = new triggers.Trigger(this, 'MyTrigger', {
  handler: function_,

  // the properties below are optional
  executeAfter: [construct],
  executeBefore: [construct],
  executeOnHandlerChange: false,
});

Initializer

new Trigger(scope: Construct, id: string, props: TriggerProps)

Parameters

• scope Construct
• id string
• props TriggerProps

Construct Props

Name	Type	Description
handler	Function	The AWS Lambda function of the handler to execute.
executeAfter?	Construct[]	Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned.
executeBefore?	Construct[]	Adds this trigger as a dependency on other constructs.
executeOnHandlerChange?	boolean	Re-executes the trigger every time the handler changes.

---

handler

Type: Function

The AWS Lambda function of the handler to execute.

---

executeAfter?

Type: Construct[] (optional, default: [])

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?

Type: Construct[] (optional, default: [])

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 dependants.

---

executeOnHandlerChange?

Type: boolean (optional, default: 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.

Properties

Name	Type	Description
node	ConstructNode	The construct tree node associated with this construct.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

Methods

Name	Description
executeAfter(...scopes)	Adds trigger dependencies.
executeBefore(...scopes)	Adds this trigger as a dependency on other constructs.
toString()	Returns a string representation of this construct.

---

executeAfter(...scopes)

public executeAfter(...scopes: Construct[]): void

Parameters

• scopes Construct

Adds trigger dependencies.

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

---

executeBefore(...scopes)

public executeBefore(...scopes: Construct[]): void

Parameters

• scopes Construct

Adds this trigger as a dependency on other constructs.

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.