software.amazon.awscdk.services.glue

Class CfnTrigger

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnTrigger

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.592Z")
 @Stability(value=Stable)
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")
         .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.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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTrigger(software.constructs.Construct scope, 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
Object	getActions() The actions initiated by this trigger.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of this trigger.
String	getName() The name of the trigger.
Object	getPredicate() The predicate of this trigger, which defines when it will fire.
String	getSchedule() A `cron` expression used to specify the schedule.
Object	getStartOnCreation() Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created.
TagManager	getTags() The tags to use with this trigger.
String	getType() The type of trigger that this is.
String	getWorkflowName() The name of the workflow associated with the trigger.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(IResolvable value) The actions initiated by this trigger.
void	setActions(List<Object> value) The actions initiated by this trigger.
void	setDescription(String value) A description of this trigger.
void	setName(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(String value) A `cron` expression used to specify the schedule.
void	setStartOnCreation(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(String value) The type of trigger that this is.
void	setWorkflowName(String value) The name of the workflow associated with the trigger.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnTrigger(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to use with this trigger.

getActions

@Stability(value=Stable)
 @NotNull
public Object getActions()

The actions initiated by this trigger.

setActions

@Stability(value=Stable)
public void setActions(@NotNull
                                                IResolvable value)

The actions initiated by this trigger.

setActions

@Stability(value=Stable)
public void setActions(@NotNull
                                                List<Object> value)

The actions initiated by this trigger.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

The type of trigger that this is.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

The type of trigger that this is.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of this trigger.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of this trigger.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the trigger.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the trigger.

getPredicate

@Stability(value=Stable)
 @Nullable
public Object getPredicate()

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

setPredicate

@Stability(value=Stable)
public void setPredicate(@Nullable
                                                  CfnTrigger.PredicateProperty value)

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

setPredicate

@Stability(value=Stable)
public void setPredicate(@Nullable
                                                  IResolvable value)

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

getSchedule

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 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

@Stability(value=Stable)
 @Nullable
public Object getStartOnCreation()

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

True is not supported for ON_DEMAND triggers.

setStartOnCreation

@Stability(value=Stable)
public void setStartOnCreation(@Nullable
                                                        Boolean value)

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

True is not supported for ON_DEMAND triggers.

setStartOnCreation

@Stability(value=Stable)
public void setStartOnCreation(@Nullable
                                                        IResolvable value)

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

True is not supported for ON_DEMAND triggers.

getWorkflowName

@Stability(value=Stable)
 @Nullable
public String getWorkflowName()

The name of the workflow associated with the trigger.

setWorkflowName

@Stability(value=Stable)
public void setWorkflowName(@Nullable
                                                     String value)

The name of the workflow associated with the trigger.