ScheduledTriggerOptions

class aws_cdk.aws_glue.ScheduledTriggerOptions(*, actions, description=None, name=None, start_on_creation=None, schedule)

Bases: StartableTriggerOptions

Properties for configuring a scheduled Glue Trigger.

Parameters:

actions (Sequence[Action]) – The actions initiated by this trigger.
description (Optional[str]) – A description for the trigger. Default: - no description
name (Optional[str]) – A name for the trigger. Default: - no name is provided
start_on_creation (Optional[bool]) – Whether to start the trigger on creation or not. Default: - false
schedule (TriggerSchedule) – The schedule on which this trigger fires. Build one with {@link TriggerSchedule.daily}, {@link TriggerSchedule.weekly}, {@link TriggerSchedule.cron}, or {@link TriggerSchedule.expression}.

ExampleMetadata:

infused

Example:

import aws_cdk as cdk
import aws_cdk.aws_iam as iam
# stack: cdk.Stack
# role: iam.IRole
# script: glue.Code

job = glue.PySparkEtlJob(stack, "Job", role=role, script=script)
workflow = glue.Workflow(stack, "Workflow")

workflow.add_scheduled_trigger("WeeklyTrigger",
    actions=[glue.Action.job(job)],
    schedule=glue.TriggerSchedule.weekly()
)

Attributes

actions: The actions initiated by this trigger.

description

A description for the trigger.

Default:

no description

name

A name for the trigger.

Default:

no name is provided

schedule

The schedule on which this trigger fires.

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

start_on_creation

Whether to start the trigger on creation or not.

Default:

false