Package software.amazon.awscdk.services.glue

Interface CfnTriggerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTriggerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:31.955Z")
@Stability(Stable)
public interface CfnTriggerProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTriggerProps.Builder	A builder for CfnTriggerProps
static final class	CfnTriggerProps.Jsii$Proxy	An implementation for CfnTriggerProps

Method Summary

Modifier and Type	Method	Description
static CfnTriggerProps.Builder	builder()
Object	getActions()	The actions initiated by this trigger.
default String	getDescription()	A description of this trigger.
default Object	getEventBatchingCondition()	Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
default String	getName()	The name of the trigger.
default Object	getPredicate()	The predicate of this trigger, which defines when it will fire.
default String	getSchedule()	A cron expression used to specify the schedule.
default Object	getStartOnCreation()	Set to true to start SCHEDULED and CONDITIONAL triggers when created.
default Object	getTags()	The tags to use with this trigger.
String	getType()	The type of trigger that this is.
default String	getWorkflowName()	The name of the workflow associated with the trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The actions initiated by this trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-actions

getType

@Stability(Stable)
@NotNull
String getType()

The type of trigger that this is.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-type

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of this trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-description

getEventBatchingCondition

@Stability(Stable)
@Nullable
default Object getEventBatchingCondition()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-eventbatchingcondition

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-name

getPredicate

@Stability(Stable)
@Nullable
default Object getPredicate()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-predicate

getSchedule

@Stability(Stable)
@Nullable
default String getSchedule()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-schedule

getStartOnCreation

@Stability(Stable)
@Nullable
default Object getStartOnCreation()

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

True is not supported for ON_DEMAND triggers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-startoncreation

getTags

@Stability(Stable)
@Nullable
default Object getTags()

The tags to use with this trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-tags

getWorkflowName

@Stability(Stable)
@Nullable
default String getWorkflowName()

The name of the workflow associated with the trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-workflowname

builder

@Stability(Stable)
static CfnTriggerProps.Builder builder()

Returns:

a CfnTriggerProps.Builder of CfnTriggerProps