interface IWorkflow ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Alpha.IWorkflow
Go	github.com/aws/aws-cdk-go/awscdkgluealpha/v2#IWorkflow
Java	software.amazon.awscdk.services.glue.alpha.IWorkflow
Python	aws_cdk.aws_glue_alpha.IWorkflow
TypeScript (source)	@aws-cdk/aws-glue-alpha » IWorkflow

⚠️ Deprecated: undefined

Implements IDependable, IConstruct, IEnvironmentAware, IResource

Implemented by Workflow

Obtainable from Workflow.fromWorkflowArn(), Workflow.fromWorkflowAttributes(), Workflow.fromWorkflowName()

The base interface for Glue Workflow.

See also: https://docs.aws.amazon.com/glue/latest/dg/workflows_overview.html

Properties

Name	Type	Description
env⚠️	ResourceEnvironment	The environment this resource belongs to.
node⚠️	Node	The tree node.
stack⚠️	Stack	The stack in which this resource is defined.
workflowArn⚠️	string	The ARN of the workflow.
workflowName⚠️	string	The name of the workflow.

---

env⚠️

⚠️ Deprecated: undefined

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

node⚠️

⚠️ Deprecated: undefined

Type: Node

The tree node.

---

stack⚠️

⚠️ Deprecated: undefined

Type: Stack

The stack in which this resource is defined.

---

workflowArn⚠️

⚠️ Deprecated: undefined

Type: string

The ARN of the workflow.

---

workflowName⚠️

⚠️ Deprecated: undefined

Type: string

The name of the workflow.

Methods

Name	Description
addConditionalTrigger(id, options)⚠️	Add a conditional (predicate-based) trigger to the workflow.
addEventTrigger(id, options)⚠️	Add an EventBridge event-based trigger to the workflow.
addOnDemandTrigger(id, options)⚠️	Add an on-demand trigger to the workflow.
addScheduledTrigger(id, options)⚠️	Add a scheduled trigger to the workflow.
applyRemovalPolicy(policy)⚠️	Apply the given removal policy to this resource.
with(...mixins)⚠️	Applies one or more mixins to this construct.

---

addConditionalTrigger(id, options)⚠️

public addConditionalTrigger(id: string, options: ConditionalTriggerOptions): ITriggerRef

⚠️ Deprecated: undefined

Parameters

• id string
• options ConditionalTriggerOptions

Returns

• ITriggerRef

Add a conditional (predicate-based) trigger to the workflow.

---

addEventTrigger(id, options)⚠️

public addEventTrigger(id: string, options: EventTriggerOptions): ITriggerRef

⚠️ Deprecated: undefined

Parameters

• id string
• options EventTriggerOptions

Returns

• ITriggerRef

Add an EventBridge event-based trigger to the workflow.

---

addOnDemandTrigger(id, options)⚠️

public addOnDemandTrigger(id: string, options: OnDemandTriggerOptions): ITriggerRef

⚠️ Deprecated: undefined

Parameters

• id string
• options OnDemandTriggerOptions

Returns

• ITriggerRef

Add an on-demand trigger to the workflow.

---

addScheduledTrigger(id, options)⚠️

public addScheduledTrigger(id: string, options: ScheduledTriggerOptions): ITriggerRef

⚠️ Deprecated: undefined

Parameters

• id string
• options ScheduledTriggerOptions

Returns

• ITriggerRef

Add a scheduled trigger to the workflow.

---

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

⚠️ Deprecated: undefined

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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)⚠️

public with(...mixins: IMixin[]): IConstruct

⚠️ Deprecated: undefined

Parameters

• mixins IMixin — The mixins to apply.

Returns

• 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.