Package software.amazon.awscdk.triggers

Interface TriggerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

TriggerFunctionProps, TriggerProps

All Known Implementing Classes:

TriggerFunctionProps.Jsii$Proxy, TriggerOptions.Jsii$Proxy, TriggerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:59.760Z")
@Stability(Stable)
public interface TriggerOptions
extends software.amazon.jsii.JsiiSerializable

Options for Trigger.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.triggers.*;
 import software.constructs.*;
 Construct construct;
 TriggerOptions triggerOptions = TriggerOptions.builder()
         .executeAfter(List.of(construct))
         .executeBefore(List.of(construct))
         .executeOnHandlerChange(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TriggerOptions.Builder	A builder for TriggerOptions
static final class	TriggerOptions.Jsii$Proxy	An implementation for TriggerOptions

Method Summary

Modifier and Type	Method	Description
static TriggerOptions.Builder	builder()
default List<software.constructs.Construct>	getExecuteAfter()	Adds trigger dependencies.
default List<software.constructs.Construct>	getExecuteBefore()	Adds this trigger as a dependency on other constructs.
default Boolean	getExecuteOnHandlerChange()	Re-executes the trigger every time the handler changes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecuteAfter

@Stability(Stable)
@Nullable
default List<software.constructs.Construct> getExecuteAfter()

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

getExecuteBefore

@Stability(Stable)
@Nullable
default List<software.constructs.Construct> getExecuteBefore()

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

getExecuteOnHandlerChange

@Stability(Stable)
@Nullable
default Boolean getExecuteOnHandlerChange()

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

builder

@Stability(Stable)
static TriggerOptions.Builder builder()

Returns:

a TriggerOptions.Builder of TriggerOptions