interface TriggerProps
Language | Type name |
---|---|
.NET | Amazon.CDK.Triggers.TriggerProps |
Java | software.amazon.awscdk.triggers.TriggerProps |
Python | aws_cdk.triggers.TriggerProps |
TypeScript (source) | @aws-cdk/triggers » TriggerProps |
Props for Trigger
.
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 triggerProps: triggers.TriggerProps = {
handler: function_,
// the properties below are optional
executeAfter: [construct],
executeBefore: [construct],
executeOnHandlerChange: false,
};
Properties
Name | Type | Description |
---|---|---|
handler | Function | The AWS Lambda function of the handler to execute. |
execute | Construct [] | Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned. |
execute | Construct [] | Adds this trigger as a dependency on other constructs. |
execute | 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.