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

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🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

workflowArn🔹

Type: string

The ARN of the workflow.

---

workflowName🔹

Type: string

The name of the workflow.

Methods

Name	Description
addCustomScheduledTrigger(id, options)🔹	Add an custom-scheduled trigger to the workflow.
addDailyScheduledTrigger(id, options)🔹	Add an daily-scheduled trigger to the workflow.
addOnDemandTrigger(id, options)🔹	Add an on-demand trigger to the workflow.
addWeeklyScheduledTrigger(id, options)🔹	Add an weekly-scheduled trigger to the workflow.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.

---

addCustomScheduledTrigger(id, options)🔹

public addCustomScheduledTrigger(id: string, options: CustomScheduledTriggerOptions): CfnTrigger

Parameters

• id string
• options CustomScheduledTriggerOptions

Returns

• CfnTrigger

Add an custom-scheduled trigger to the workflow.

---

addDailyScheduledTrigger(id, options)🔹

public addDailyScheduledTrigger(id: string, options: DailyScheduleTriggerOptions): CfnTrigger

Parameters

• id string
• options DailyScheduleTriggerOptions

Returns

• CfnTrigger

Add an daily-scheduled trigger to the workflow.

---

addOnDemandTrigger(id, options)🔹

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

Parameters

• id string
• options OnDemandTriggerOptions

Returns

• CfnTrigger

Add an on-demand trigger to the workflow.

---

addWeeklyScheduledTrigger(id, options)🔹

public addWeeklyScheduledTrigger(id: string, options: WeeklyScheduleTriggerOptions): CfnTrigger

Parameters

• id string
• options WeeklyScheduleTriggerOptions

Returns

• CfnTrigger

Add an weekly-scheduled trigger to the workflow.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

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