software.amazon.awscdk.triggers

Class Trigger.Builder

java.lang.Object

software.amazon.awscdk.triggers.Trigger.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Trigger>

Enclosing class:

Trigger

@Stability(value=Stable)
public static final class Trigger.Builder
extends Object
implements software.amazon.jsii.Builder<Trigger>

A fluent builder for Trigger.

Method Summary

Modifier and Type	Method and Description
Trigger	build()
static Trigger.Builder	create(software.constructs.Construct scope, String id)
Trigger.Builder	executeAfter(List<? extends software.constructs.Construct> executeAfter) Adds trigger dependencies.
Trigger.Builder	executeBefore(List<? extends software.constructs.Construct> executeBefore) Adds this trigger as a dependency on other constructs.
Trigger.Builder	executeOnHandlerChange(Boolean executeOnHandlerChange) Re-executes the trigger every time the handler changes.
Trigger.Builder	handler(Function handler) The AWS Lambda function of the handler to execute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static Trigger.Builder create(software.constructs.Construct scope,
                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Trigger.Builder.

executeAfter

@Stability(value=Stable)
public Trigger.Builder executeAfter(List<? extends software.constructs.Construct> executeAfter)

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: []

Parameters:

executeAfter - Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned. This parameter is required.

Returns:

this

executeBefore

@Stability(value=Stable)
public Trigger.Builder executeBefore(List<? extends software.constructs.Construct> executeBefore)

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: []

Parameters:

executeBefore - Adds this trigger as a dependency on other constructs. This parameter is required.

Returns:

this

executeOnHandlerChange

@Stability(value=Stable)
public Trigger.Builder executeOnHandlerChange(Boolean executeOnHandlerChange)

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

Parameters:

executeOnHandlerChange - Re-executes the trigger every time the handler changes. This parameter is required.

Returns:

this

handler

@Stability(value=Stable)
public Trigger.Builder handler(Function handler)

The AWS Lambda function of the handler to execute.

Parameters:

handler - The AWS Lambda function of the handler to execute. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Trigger build()

Specified by:

build in interface software.amazon.jsii.Builder<Trigger>