Skip to content

CreateTriggerRequest

Source code in docs_src/capo_glue/types/create_trigger_request.py
class CreateTriggerRequest(TypedDict, closed=True):
    name: "capo_glue.types.name_string.NameString"
    """<p>The name of the trigger.</p>"""
    workflow_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the workflow associated with the trigger.</p>"""
    type: "capo_glue.types.trigger_type.TriggerType"
    """<p>The type of the new trigger.</p>"""
    schedule: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A <code>cron</code> expression used to specify the schedule (see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run something every day at 12:15 UTC, you would specify: <code>cron(15 12 * * ? *)</code>.</p> <p>This field is required when the trigger type is SCHEDULED.</p>"""
    predicate: NotRequired["capo_glue.types.predicate.Predicate"]
    """<p>A predicate to specify when the new trigger should fire.</p> <p>This field is required when the trigger type is <code>CONDITIONAL</code>.</p>"""
    actions: "capo_glue.types.action_list.ActionList"
    """<p>The actions initiated by this trigger when it fires.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>A description of the new trigger.</p>"""
    start_on_creation: "capo_glue.types.boolean_value.BooleanValue"
    """<p>Set to <code>true</code> to start <code>SCHEDULED</code> and <code>CONDITIONAL</code> triggers when created. True is not supported for <code>ON_DEMAND</code> triggers.</p>"""
    tags: NotRequired["capo_glue.types.tags_map.TagsMap"]
    """<p>The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html">Amazon Web Services Tags in Glue</a> in the developer guide. </p>"""
    event_batching_condition: NotRequired[
        "capo_glue.types.event_batching_condition.EventBatchingCondition"
    ]
    """<p>Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.</p>"""

actions instance-attribute

actions: ActionList

The actions initiated by this trigger when it fires.

description instance-attribute

description: NotRequired[DescriptionString]

A description of the new trigger.

event_batching_condition instance-attribute

event_batching_condition: NotRequired[EventBatchingCondition]

Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

name instance-attribute

name: NameString

The name of the trigger.

predicate instance-attribute

predicate: NotRequired[Predicate]

A predicate to specify when the new trigger should fire.

This field is required when the trigger type is CONDITIONAL.

schedule instance-attribute

schedule: NotRequired[GenericString]

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

This field is required when the trigger type is SCHEDULED.

start_on_creation instance-attribute

start_on_creation: BooleanValue

Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

tags instance-attribute

tags: NotRequired[TagsMap]

The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

type instance-attribute

The type of the new trigger.

workflow_name instance-attribute

workflow_name: NotRequired[NameString]

The name of the workflow associated with the trigger.