aws-cdk-lib.aws_glue.CfnTriggerProps

interface CfnTriggerProps

LanguageType name
.NETAmazon.CDK.AWS.Glue.CfnTriggerProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnTriggerProps
Javasoftware.amazon.awscdk.services.glue.CfnTriggerProps
Pythonaws_cdk.aws_glue.CfnTriggerProps
TypeScript aws-cdk-lib » aws_glue » CfnTriggerProps

Properties for defining a CfnTrigger.

Example

// 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

NameTypeDescription
actionsIResolvable | IResolvable | ActionProperty[]The actions initiated by this trigger.
typestringThe type of trigger that this is.
description?stringA description of this trigger.
eventBatchingCondition?IResolvable | EventBatchingConditionPropertyBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
name?stringThe name of the trigger.
predicate?IResolvable | PredicatePropertyThe predicate of this trigger, which defines when it will fire.
schedule?stringA cron expression used to specify the schedule.
startOnCreation?boolean | IResolvableSet to true to start SCHEDULED and CONDITIONAL triggers when created.
tags?anyThe tags to use with this trigger.
workflowName?stringThe name of the workflow associated with the trigger.

actions

Type: IResolvable | IResolvable | ActionProperty[]

The actions initiated by this trigger.


type

Type: string

The type of trigger that this is.


description?

Type: string (optional)

A description of this trigger.


eventBatchingCondition?

Type: IResolvable | EventBatchingConditionProperty (optional)

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


name?

Type: string (optional)

The name of the trigger.


predicate?

Type: IResolvable | PredicateProperty (optional)

The predicate of this trigger, which defines when it will fire.


schedule?

Type: string (optional)

A cron expression used to specify the schedule.

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 * * ? *) .


startOnCreation?

Type: boolean | IResolvable (optional)

Set to true to start SCHEDULED and CONDITIONAL triggers when created.

True is not supported for ON_DEMAND triggers.


tags?

Type: any (optional)

The tags to use with this trigger.


workflowName?

Type: string (optional)

The name of the workflow associated with the trigger.