Skip to content
v2.274.0

IWorkflow Interface ​

The base interface for Glue Workflow.

Properties ​

The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
workflowArnstringworkflow_arnstrworkflowArnStringWorkflowArnstringWorkflowArn*stringrequired#
The ARN of the workflow.
workflowNamestringworkflow_namestrworkflowNameStringWorkflowNamestringWorkflowName*stringrequired#
The name of the workflow.

Methods ​

addConditionalTrigger(id: string, options: ConditionalTriggerOptions): ITriggerRefdef add_conditional_trigger(self, id: str, options: ConditionalTriggerOptions) -> ITriggerRefpublic ITriggerRef addConditionalTrigger(String id, ConditionalTriggerOptions options)public ITriggerRef AddConditionalTrigger(string id, ConditionalTriggerOptions options)func AddConditionalTrigger(Id *string, Options ConditionalTriggerOptions) ITriggerRef#
Add a conditional (predicate-based) trigger to the workflow.
returns

Returns: a reference to the created trigger.

addEventTrigger(id: string, options: EventTriggerOptions): ITriggerRefdef add_event_trigger(self, id: str, options: EventTriggerOptions) -> ITriggerRefpublic ITriggerRef addEventTrigger(String id, EventTriggerOptions options)public ITriggerRef AddEventTrigger(string id, EventTriggerOptions options)func AddEventTrigger(Id *string, Options EventTriggerOptions) ITriggerRef#
Add an EventBridge event-based trigger to the workflow.
returns

Returns: a reference to the created trigger.

addOnDemandTrigger(id: string, options: OnDemandTriggerOptions): ITriggerRefdef add_on_demand_trigger(self, id: str, options: OnDemandTriggerOptions) -> ITriggerRefpublic ITriggerRef addOnDemandTrigger(String id, OnDemandTriggerOptions options)public ITriggerRef AddOnDemandTrigger(string id, OnDemandTriggerOptions options)func AddOnDemandTrigger(Id *string, Options OnDemandTriggerOptions) ITriggerRef#
Add an on-demand trigger to the workflow.
returns

Returns: a reference to the created trigger.

addScheduledTrigger(id: string, options: ScheduledTriggerOptions): ITriggerRefdef add_scheduled_trigger(self, id: str, options: ScheduledTriggerOptions) -> ITriggerRefpublic ITriggerRef addScheduledTrigger(String id, ScheduledTriggerOptions options)public ITriggerRef AddScheduledTrigger(string id, ScheduledTriggerOptions options)func AddScheduledTrigger(Id *string, Options ScheduledTriggerOptions) ITriggerRef#
Add a scheduled trigger to the workflow.
returns

Returns: a reference to the created trigger.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining