Trigger

class aws_cdk.triggers.Trigger(scope, id, *, handler, execute_after=None, execute_before=None, execute_on_handler_change=None)

Bases: Construct

Triggers an AWS Lambda function during deployment.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lambda as lambda_
import aws_cdk.triggers as triggers
import constructs as constructs

# construct: constructs.Construct
# function_: lambda.Function

trigger = triggers.Trigger(self, "MyTrigger",
    handler=function_,

    # the properties below are optional
    execute_after=[construct],
    execute_before=[construct],
    execute_on_handler_change=False
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • handler (Function) – The AWS Lambda function of the handler to execute.

  • execute_after (Optional[Sequence[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. Default: []

  • execute_before (Optional[Sequence[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 dependants. Default: []

  • execute_on_handler_change (Optional[bool]) – 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. Default: true

Methods

execute_after(*scopes)

Adds trigger dependencies.

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

Parameters:

scopes (Construct) –

Return type:

None

execute_before(*scopes)

Adds this trigger as a dependency on other constructs.

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

Parameters:

scopes (Construct) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

node

The construct tree node associated with this construct.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool