class WorkflowBase 🔹

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

Implements IConstruct, IDependable, IResource, IWorkflow

Extends Resource

Implemented by Workflow

Base abstract class for Workflow.

See also: https://docs.aws.amazon.com/glue/latest/dg/about-triggers.html

Initializer

new WorkflowBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

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 a custom-scheduled trigger to the workflow.
addDailyScheduledTrigger(id, options)🔹	Add a daily-scheduled trigger to the workflow.
addNotifyEventTrigger(id, options)🔹	Add an Event Bridge based trigger to the workflow.
addOnDemandTrigger(id, options)🔹	Add an on-demand trigger to the workflow.
addWeeklyScheduledTrigger(id, options)🔹	Add a weekly-scheduled trigger to the workflow.
addconditionalTrigger(id, options)🔹	Add a Condition (Predicate) based trigger to the workflow.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
protected buildWorkflowArn(scope, workflowName)🔹
protected static extractNameFromArn(scope, workflowArn)🔹	Extract workflowName from arn.

---

addCustomScheduledTrigger(id, options)🔹

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

Parameters

• id string  1¤7 The id of the trigger.
• options CustomScheduledTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add a custom-scheduled trigger to the workflow.

---

addDailyScheduledTrigger(id, options)🔹

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

Parameters

• id string  1¤7 The id of the trigger.
• options DailyScheduleTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add a daily-scheduled trigger to the workflow.

---

addNotifyEventTrigger(id, options)🔹

public addNotifyEventTrigger(id: string, options: NotifyEventTriggerOptions): CfnTrigger

Parameters

• id string  1¤7 The id of the trigger.
• options NotifyEventTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add an Event Bridge based trigger to the workflow.

---

addOnDemandTrigger(id, options)🔹

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

Parameters

• id string  1¤7 The id of the trigger.
• options OnDemandTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add an on-demand trigger to the workflow.

---

addWeeklyScheduledTrigger(id, options)🔹

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

Parameters

• id string  1¤7 The id of the trigger.
• options WeeklyScheduleTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add a weekly-scheduled trigger to the workflow.

---

addconditionalTrigger(id, options)🔹

public addconditionalTrigger(id: string, options: ConditionalTriggerOptions): CfnTrigger

Parameters

• id string  1¤7 The id of the trigger.
• options ConditionalTriggerOptions  1¤7 Additional options for the trigger.

Returns

• CfnTrigger

Add a Condition (Predicate) based 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).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected buildWorkflowArn(scope, workflowName)🔹

protected buildWorkflowArn(scope: Construct, workflowName: string): string

Parameters

• scope Construct
• workflowName string

Returns

• string

---

protected static extractNameFromArn(scope, workflowArn)🔹

protected static extractNameFromArn(scope: Construct, workflowArn: string): string

Parameters

• scope Construct
• workflowArn string

Returns

• string

Extract workflowName from arn.