TriggerArgs class
The set of arguments for Trigger. The set of arguments for Trigger.
Constructors
-
TriggerArgs({required Input<
List< actions, Input<TriggerAction> >String?> ? description, Input<bool?> ? enabled, Input<List< ? eventBatchingConditions, Input<TriggerEventBatchingCondition> ?>String?> ? name, Input<TriggerPredicate?> ? predicate, Input<String?> ? region, Input<String?> ? schedule, Input<bool?> ? startOnCreation, Input<Map< ? tags, required Input<String, String> ?>String> type, Input<String?> ? workflowName}) -
Creates a new TriggerArgs.
actionsList of actions initiated by this trigger when it fires. See Actions Below.descriptionA description of the new trigger.enabledStart the trigger. Defaults totrue.eventBatchingConditionsBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. See Event Batching Condition.nameThe name of the trigger.predicateA predicate to specify when the new trigger should fire. Required when trigger type isCONDITIONAL. See Predicate Below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.scheduleA cron expression used to specify the schedule. Time-Based Schedules for Jobs and CrawlersstartOnCreationSet to true to startSCHEDULEDandCONDITIONALtriggers when created. True is not supported forON_DEMANDtriggers.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.typeThe type of trigger. Valid values areCONDITIONAL,EVENT,ON_DEMAND, andSCHEDULED.workflowNameA workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (ON_DEMANDorSCHEDULEDtype) and can contain multiple additionalCONDITIONALtriggers.const -
TriggerArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
actions
→ Input<
List< TriggerAction> > -
List of actions initiated by this trigger when it fires. See Actions Below.
final
-
description
→ Input<
String?> ? -
A description of the new trigger.
final
-
enabled
→ Input<
bool?> ? -
Start the trigger. Defaults to
true.final -
eventBatchingConditions
→ Input<
List< ?TriggerEventBatchingCondition> ?> -
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. See Event Batching Condition.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
name
→ Input<
String?> ? -
The name of the trigger.
final
-
predicate
→ Input<
TriggerPredicate?> ? -
A predicate to specify when the new trigger should fire. Required when trigger type is
CONDITIONAL. See Predicate Below.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedule
→ Input<
String?> ? -
A cron expression used to specify the schedule. Time-Based Schedules for Jobs and Crawlers
final
-
startOnCreation
→ Input<
bool?> ? -
Set to true to start
SCHEDULEDandCONDITIONALtriggers when created. True is not supported forON_DEMANDtriggers.final -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
type
→ Input<
String> -
The type of trigger. Valid values are
CONDITIONAL,EVENT,ON_DEMAND, andSCHEDULED.final -
workflowName
→ Input<
String?> ? -
A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (
ON_DEMANDorSCHEDULEDtype) and can contain multiple additionalCONDITIONALtriggers.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited