software.amazon.awscdk.services.glue

Class CfnTrigger

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.glue.CfnTrigger

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.612Z")
public class CfnTrigger
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::Trigger`.

The AWS::Glue::Trigger resource specifies triggers that run AWS Glue jobs. For more information, see Triggering Jobs in AWS Glue and Trigger Structure in the AWS Glue Developer Guide .

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;
 CfnTrigger cfnTrigger = CfnTrigger.Builder.create(this, "MyCfnTrigger")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnTrigger.ActionProperty Defines an action to be initiated by a trigger.
static class	CfnTrigger.Builder A fluent builder for CfnTrigger.
static interface	CfnTrigger.ConditionProperty Defines a condition under which a trigger fires.
static interface	CfnTrigger.EventBatchingConditionProperty Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
static interface	CfnTrigger.NotificationPropertyProperty Specifies configuration properties of a job run notification.
static interface	CfnTrigger.PredicateProperty Defines the predicate of the trigger, which determines when it fires.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTrigger(Construct scope, java.lang.String id, CfnTriggerProps props) Create a new `AWS::Glue::Trigger`.
protected	CfnTrigger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTrigger(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getActions() The actions initiated by this trigger.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of this trigger.
java.lang.Object	getEventBatchingCondition() Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
java.lang.String	getName() The name of the trigger.
java.lang.Object	getPredicate() The predicate of this trigger, which defines when it will fire.
java.lang.String	getSchedule() A `cron` expression used to specify the schedule.
java.lang.Object	getStartOnCreation() Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created.
TagManager	getTags() The tags to use with this trigger.
java.lang.String	getType() The type of trigger that this is.
java.lang.String	getWorkflowName() The name of the workflow associated with the trigger.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setActions(IResolvable value) The actions initiated by this trigger.
void	setActions(java.util.List<java.lang.Object> value) The actions initiated by this trigger.
void	setDescription(java.lang.String value) A description of this trigger.
void	setEventBatchingCondition(CfnTrigger.EventBatchingConditionProperty value) Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
void	setEventBatchingCondition(IResolvable value) Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
void	setName(java.lang.String value) The name of the trigger.
void	setPredicate(CfnTrigger.PredicateProperty value) The predicate of this trigger, which defines when it will fire.
void	setPredicate(IResolvable value) The predicate of this trigger, which defines when it will fire.
void	setSchedule(java.lang.String value) A `cron` expression used to specify the schedule.
void	setStartOnCreation(java.lang.Boolean value) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created.
void	setStartOnCreation(IResolvable value) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created.
void	setType(java.lang.String value) The type of trigger that this is.
void	setWorkflowName(java.lang.String value) The name of the workflow associated with the trigger.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTrigger

protected CfnTrigger(software.amazon.jsii.JsiiObjectRef objRef)

CfnTrigger

protected CfnTrigger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTrigger

public CfnTrigger(Construct scope,
                  java.lang.String id,
                  CfnTriggerProps props)

Create a new `AWS::Glue::Trigger`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to use with this trigger.

getActions

public java.lang.Object getActions()

The actions initiated by this trigger.

setActions

public void setActions(IResolvable value)

The actions initiated by this trigger.

setActions

public void setActions(java.util.List<java.lang.Object> value)

The actions initiated by this trigger.

getType

public java.lang.String getType()

The type of trigger that this is.

setType

public void setType(java.lang.String value)

The type of trigger that this is.

getDescription

public java.lang.String getDescription()

A description of this trigger.

setDescription

public void setDescription(java.lang.String value)

A description of this trigger.

getEventBatchingCondition

public java.lang.Object getEventBatchingCondition()

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

setEventBatchingCondition

public void setEventBatchingCondition(IResolvable value)

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

setEventBatchingCondition

public void setEventBatchingCondition(CfnTrigger.EventBatchingConditionProperty value)

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

getName

public java.lang.String getName()

The name of the trigger.

setName

public void setName(java.lang.String value)

The name of the trigger.

getPredicate

public java.lang.Object getPredicate()

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

setPredicate

public void setPredicate(IResolvable value)

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

setPredicate

public void setPredicate(CfnTrigger.PredicateProperty value)

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

getSchedule

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

setSchedule

public void setSchedule(java.lang.String value)

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

getStartOnCreation

public java.lang.Object getStartOnCreation()

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

True is not supported for ON_DEMAND triggers.

setStartOnCreation

public void setStartOnCreation(java.lang.Boolean value)

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

True is not supported for ON_DEMAND triggers.

setStartOnCreation

public void setStartOnCreation(IResolvable value)

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

True is not supported for ON_DEMAND triggers.

getWorkflowName

public java.lang.String getWorkflowName()

The name of the workflow associated with the trigger.

setWorkflowName

public void setWorkflowName(java.lang.String value)

The name of the workflow associated with the trigger.