Skip to content
v2.274.0

ScheduledTriggerOptions Struct ​

Properties for configuring a scheduled Glue Trigger.

Example ​

ts
import * as cdk from 'aws-cdk-lib';
import * as iam from 'aws-cdk-lib/aws-iam';
declare const stack: cdk.Stack;
declare const role: iam.IRole;
declare const script: glue.Code;
const job = new glue.PySparkEtlJob(stack, 'Job', { role, script });
const workflow = new glue.Workflow(stack, 'Workflow');

workflow.addScheduledTrigger('WeeklyTrigger', {
  actions: [glue.Action.job(job)],
  schedule: glue.TriggerSchedule.weekly(),
});

Properties ​

actionsAction[]actionstyping.List[Action]actionsList<Action>ActionsAction[]Actions*[]Actionrequired#
The actions initiated by this trigger.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description for the trigger.

Default: no description

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A name for the trigger.

Default: no name is provided

The schedule on which this trigger fires.

Build one with {@link TriggerSchedule.daily}, {@link TriggerSchedule.weekly}, {@link TriggerSchedule.cron}, or {@link TriggerSchedule.expression}.

startOnCreationoptionalbooleanstart_on_creationoptionalboolstartOnCreationoptionalBooleanStartOnCreationoptionalboolStartOnCreationoptional*bool= false#
Whether to start the trigger on creation or not.