Class WorkflowBase

(experimental) Base abstract class for Workflow.

Inheritance

object

Resource

WorkflowBase

Workflow

Implements

IWorkflow

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Glue.Alpha

Assembly: Amazon.CDK.AWS.Glue.Alpha.dll

Syntax (csharp)

public abstract class WorkflowBase : Resource, IWorkflow, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class WorkflowBase Inherits Resource Implements IWorkflow, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

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

Synopsis

Constructors

WorkflowBase(Construct, string, IResourceProps?)

(experimental) Base abstract class for Workflow.

Properties

WorkflowArn	(experimental) The ARN of the workflow.
WorkflowName	(experimental) The name of the workflow.

Methods

AddConditionalTrigger(string, IConditionalTriggerOptions)	(experimental) Add a Condition (Predicate) based trigger to the workflow.
AddCustomScheduledTrigger(string, ICustomScheduledTriggerOptions)	(experimental) Add a custom-scheduled trigger to the workflow.
AddDailyScheduledTrigger(string, IDailyScheduleTriggerOptions)	(experimental) Add a daily-scheduled trigger to the workflow.
AddNotifyEventTrigger(string, INotifyEventTriggerOptions)	(experimental) Add an Event Bridge based trigger to the workflow.
AddOnDemandTrigger(string, IOnDemandTriggerOptions)	(experimental) Add an on-demand trigger to the workflow.
AddWeeklyScheduledTrigger(string, IWeeklyScheduleTriggerOptions)	(experimental) Add a weekly-scheduled trigger to the workflow.
BuildWorkflowArn(Construct, string)	(experimental) Base abstract class for Workflow.
ExtractNameFromArn(Construct, string)	(experimental) Extract workflowName from arn.

Constructors

WorkflowBase(Construct, string, IResourceProps?)

(experimental) Base abstract class for Workflow.

protected WorkflowBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct
id string
props IResourceProps

Remarks

Stability: Experimental

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

Properties

WorkflowArn

(experimental) The ARN of the workflow.

public abstract string WorkflowArn { get; }

Property Value

string

Remarks

Stability: Experimental

WorkflowName

(experimental) The name of the workflow.

public abstract string WorkflowName { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

AddConditionalTrigger(string, IConditionalTriggerOptions)

(experimental) Add a Condition (Predicate) based trigger to the workflow.

public virtual CfnTrigger AddConditionalTrigger(string id, IConditionalTriggerOptions options)

Parameters

id string: The id of the trigger.
options IConditionalTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If a job is provided without a job state, or if a crawler is provided without a crawler state for any condition.

AddCustomScheduledTrigger(string, ICustomScheduledTriggerOptions)

(experimental) Add a custom-scheduled trigger to the workflow.

public virtual CfnTrigger AddCustomScheduledTrigger(string id, ICustomScheduledTriggerOptions options)

Parameters

id string: The id of the trigger.
options ICustomScheduledTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If both job and crawler are provided, or if neither job nor crawler is provided.

AddDailyScheduledTrigger(string, IDailyScheduleTriggerOptions)

(experimental) Add a daily-scheduled trigger to the workflow.

public virtual CfnTrigger AddDailyScheduledTrigger(string id, IDailyScheduleTriggerOptions options)

Parameters

id string: The id of the trigger.
options IDailyScheduleTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If both job and crawler are provided, or if neither job nor crawler is provided.

AddNotifyEventTrigger(string, INotifyEventTriggerOptions)

(experimental) Add an Event Bridge based trigger to the workflow.

public virtual CfnTrigger AddNotifyEventTrigger(string id, INotifyEventTriggerOptions options)

Parameters

id string: The id of the trigger.
options INotifyEventTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If both job and crawler are provided, or if neither job nor crawler is provided.

AddOnDemandTrigger(string, IOnDemandTriggerOptions)

(experimental) Add an on-demand trigger to the workflow.

public virtual CfnTrigger AddOnDemandTrigger(string id, IOnDemandTriggerOptions options)

Parameters

id string: The id of the trigger.
options IOnDemandTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If both job and crawler are provided, or if neither job nor crawler is provided.

AddWeeklyScheduledTrigger(string, IWeeklyScheduleTriggerOptions)

(experimental) Add a weekly-scheduled trigger to the workflow.

public virtual CfnTrigger AddWeeklyScheduledTrigger(string id, IWeeklyScheduleTriggerOptions options)

Parameters

id string: The id of the trigger.
options IWeeklyScheduleTriggerOptions: Additional options for the trigger.

Returns

CfnTrigger

The created CfnTrigger resource.

Remarks

Stability: Experimental

Throws: If both job and crawler are provided, or if neither job nor crawler is provided.

BuildWorkflowArn(Construct, string)

(experimental) Base abstract class for Workflow.

protected virtual string BuildWorkflowArn(Construct scope, string workflowName)

Parameters

scope Construct
workflowName string

Returns

string

Remarks

Stability: Experimental

ExtractNameFromArn(Construct, string)

(experimental) Extract workflowName from arn.

protected static string ExtractNameFromArn(Construct scope, string workflowArn)

Parameters

scope Construct
workflowArn string

Returns

string

Remarks

Stability: Experimental

Implements

IWorkflow

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware