Skip to content
v2.278.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

# arguments_: Any
# tags: Any

cfn_trigger_props = glue.CfnTriggerProps(
    actions=[glue.CfnTrigger.ActionProperty(
        arguments=arguments_,
        crawler_name="crawlerName",
        job_name="jobName",
        notification_property=glue.CfnTrigger.NotificationPropertyProperty(
            notify_delay_after=123
        ),
        security_configuration="securityConfiguration",
        timeout=123
    )],
    type="type",

    # the properties below are optional
    description="description",
    event_batching_condition=glue.CfnTrigger.EventBatchingConditionProperty(
        batch_size=123,

        # the properties below are optional
        batch_window=123
    ),
    name="name",
    predicate=glue.CfnTrigger.PredicateProperty(
        conditions=[glue.CfnTrigger.ConditionProperty(
            crawler_name="crawlerName",
            crawl_state="crawlState",
            job_name="jobName",
            logical_operator="logicalOperator",
            state="state"
        )],
        logical="logical"
    ),
    schedule="schedule",
    start_on_creation=False,
    tags=tags,
    workflow_name="workflowName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.glue.*;

Object arguments_;
Object tags;

CfnTriggerProps cfnTriggerProps = CfnTriggerProps.builder()
        .actions(List.of(ActionProperty.builder()
                .arguments(arguments_)
                .crawlerName("crawlerName")
                .jobName("jobName")
                .notificationProperty(NotificationPropertyProperty.builder()
                        .notifyDelayAfter(123)
                        .build())
                .securityConfiguration("securityConfiguration")
                .timeout(123)
                .build()))
        .type("type")

        // the properties below are optional
        .description("description")
        .eventBatchingCondition(EventBatchingConditionProperty.builder()
                .batchSize(123)

                // the properties below are optional
                .batchWindow(123)
                .build())
        .name("name")
        .predicate(PredicateProperty.builder()
                .conditions(List.of(ConditionProperty.builder()
                        .crawlerName("crawlerName")
                        .crawlState("crawlState")
                        .jobName("jobName")
                        .logicalOperator("logicalOperator")
                        .state("state")
                        .build()))
                .logical("logical")
                .build())
        .schedule("schedule")
        .startOnCreation(false)
        .tags(tags)
        .workflowName("workflowName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;

var arguments_;
var tags;

var cfnTriggerProps = new CfnTriggerProps {
    Actions = new [] { new ActionProperty {
        Arguments = arguments_,
        CrawlerName = "crawlerName",
        JobName = "jobName",
        NotificationProperty = new NotificationPropertyProperty {
            NotifyDelayAfter = 123
        },
        SecurityConfiguration = "securityConfiguration",
        Timeout = 123
    } },
    Type = "type",

    // the properties below are optional
    Description = "description",
    EventBatchingCondition = new EventBatchingConditionProperty {
        BatchSize = 123,

        // the properties below are optional
        BatchWindow = 123
    },
    Name = "name",
    Predicate = new PredicateProperty {
        Conditions = new [] { new ConditionProperty {
            CrawlerName = "crawlerName",
            CrawlState = "crawlState",
            JobName = "jobName",
            LogicalOperator = "logicalOperator",
            State = "state"
        } },
        Logical = "logical"
    },
    Schedule = "schedule",
    StartOnCreation = false,
    Tags = tags,
    WorkflowName = "workflowName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var arguments_ interface{}
var tags interface{}

cfnTriggerProps := &CfnTriggerProps{
	Actions: []interface{}{
		&ActionProperty{
			Arguments: arguments_,
			CrawlerName: jsii.String("crawlerName"),
			JobName: jsii.String("jobName"),
			NotificationProperty: &NotificationPropertyProperty{
				NotifyDelayAfter: jsii.Number(123),
			},
			SecurityConfiguration: jsii.String("securityConfiguration"),
			Timeout: jsii.Number(123),
		},
	},
	Type: jsii.String("type"),

	// the properties below are optional
	Description: jsii.String("description"),
	EventBatchingCondition: &EventBatchingConditionProperty{
		BatchSize: jsii.Number(123),

		// the properties below are optional
		BatchWindow: jsii.Number(123),
	},
	Name: jsii.String("name"),
	Predicate: &PredicateProperty{
		Conditions: []interface{}{
			&ConditionProperty{
				CrawlerName: jsii.String("crawlerName"),
				CrawlState: jsii.String("crawlState"),
				JobName: jsii.String("jobName"),
				LogicalOperator: jsii.String("logicalOperator"),
				State: jsii.String("state"),
			},
		},
		Logical: jsii.String("logical"),
	},
	Schedule: jsii.String("schedule"),
	StartOnCreation: jsii.Boolean(false),
	Tags: tags,
	WorkflowName: jsii.String("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*string required #
The type of trigger that this is.
workflowNameoptionalstringworkflow_nameoptionalstrworkflowNameoptionalStringWorkflowNameoptionalstringWorkflowNameoptional*string #
The name of the workflow associated with the trigger.