Skip to content
v2.275.0

CfnTriggerProps Struct ​

Properties for defining a CfnTrigger.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const arguments_: any;
declare const tags: any;
const cfnTriggerProps: glue.CfnTriggerProps = {
  actions: [{
    arguments: arguments_,
    crawlerName: 'crawlerName',
    jobName: 'jobName',
    notificationProperty: {
      notifyDelayAfter: 123,
    },
    securityConfiguration: 'securityConfiguration',
    timeout: 123,
  }],
  type: 'type',

  // the properties below are optional
  description: 'description',
  eventBatchingCondition: {
    batchSize: 123,

    // the properties below are optional
    batchWindow: 123,
  },
  name: 'name',
  predicate: {
    conditions: [{
      crawlerName: 'crawlerName',
      crawlState: 'crawlState',
      jobName: 'jobName',
      logicalOperator: 'logicalOperator',
      state: 'state',
    }],
    logical: 'logical',
  },
  schedule: 'schedule',
  startOnCreation: false,
  tags: tags,
  workflowName: 'workflowName',
};

Properties ​

actionsIResolvable | IResolvable | CfnTrigger.ActionProperty[]actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ActionProperty]]]actionsIResolvableActionsIResolvableActionsinterface{}required#
The actions initiated by this trigger.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of this trigger.
eventBatchingConditionoptionalIResolvable | CfnTrigger.EventBatchingConditionPropertyevent_batching_conditionoptionaltyping.Union[IResolvable, EventBatchingConditionProperty]eventBatchingConditionoptionalIResolvableEventBatchingConditionoptionalIResolvableEventBatchingConditionoptionalinterface{}#
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the trigger.
predicateoptionalIResolvable | CfnTrigger.PredicatePropertypredicateoptionaltyping.Union[IResolvable, PredicateProperty]predicateoptionalIResolvablePredicateoptionalIResolvablePredicateoptionalinterface{}#
The predicate of this trigger, which defines when it will fire.
scheduleoptionalstringscheduleoptionalstrscheduleoptionalStringScheduleoptionalstringScheduleoptional*string#
A `cron` expression used to specify the schedule.
notes

For more information, see Time-Based Schedules for Jobs and Crawlers in the AWS Glue Developer Guide . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .

startOnCreationoptionalboolean | IResolvablestart_on_creationoptionaltyping.Union[bool, IResolvable]startOnCreationoptionalBooleanStartOnCreationoptionalboolStartOnCreationoptionalinterface{}#
Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created.

True is not supported for ON_DEMAND triggers.

tagsoptionalanytagsoptionalAnytagsoptionalObjectTagsoptionalobjectTagsoptionalinterface{}#
The tags to use with this trigger.
typestringtypestrtypeStringTypestringType*stringrequired#
The type of trigger that this is.
workflowNameoptionalstringworkflow_nameoptionalstrworkflowNameoptionalStringWorkflowNameoptionalstringWorkflowNameoptional*string#
The name of the workflow associated with the trigger.