@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:45.612Z") public class CfnTrigger extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTrigger(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTrigger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTrigger(Construct scope, java.lang.String id, CfnTriggerProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getActions()
public void setActions(IResolvable value)
public void setActions(java.util.List<java.lang.Object> value)
public java.lang.String getType()
public void setType(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getEventBatchingCondition()
public void setEventBatchingCondition(IResolvable value)
public void setEventBatchingCondition(CfnTrigger.EventBatchingConditionProperty value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getPredicate()
public void setPredicate(IResolvable value)
public void setPredicate(CfnTrigger.PredicateProperty value)
public java.lang.String getSchedule()
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 * * ? *)
.
public void setSchedule(java.lang.String value)
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 * * ? *)
.
public java.lang.Object getStartOnCreation()
True is not supported for ON_DEMAND
triggers.
public void setStartOnCreation(java.lang.Boolean value)
True is not supported for ON_DEMAND
triggers.
public void setStartOnCreation(IResolvable value)
True is not supported for ON_DEMAND
triggers.
public java.lang.String getWorkflowName()
public void setWorkflowName(java.lang.String value)