IWorkflow

class aws_cdk.aws_glue.IWorkflow(*args, **kwargs)

Bases: IResource, Protocol

The base interface for Glue Workflow.

See:

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

Methods

add_conditional_trigger(id, *, predicate, start_on_creation=None, actions, description=None, name=None)

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

Parameters:

  • id (str)

  • predicate (Union[Predicate, Dict[str, Any]]) – The predicate for the trigger.

  • start_on_creation (Optional[bool]) – Whether to start the trigger on creation or not. Default: - false

  • actions (Sequence[Action]) – The actions initiated by this trigger.

  • description (Optional[str]) – A description for the trigger. Default: - no description

  • name (Optional[str]) – A name for the trigger. Default: - no name is provided

Return type:

ITriggerRef

Returns:

a reference to the created trigger.

add_event_trigger(id, *, event_batching_condition=None, actions, description=None, name=None)

Add an EventBridge event-based trigger to the workflow.

Parameters:

  • id (str)

  • event_batching_condition (Union[EventBatchingCondition, Dict[str, Any], None]) – Batch condition for the trigger. Default: - no batch condition

  • actions (Sequence[Action]) – The actions initiated by this trigger.

  • description (Optional[str]) – A description for the trigger. Default: - no description

  • name (Optional[str]) – A name for the trigger. Default: - no name is provided

Return type:

ITriggerRef

Returns:

a reference to the created trigger.

add_on_demand_trigger(id, *, actions, description=None, name=None)

Add an on-demand trigger to the workflow.

Parameters:

  • id (str)

  • actions (Sequence[Action]) – The actions initiated by this trigger.

  • description (Optional[str]) – A description for the trigger. Default: - no description

  • name (Optional[str]) – A name for the trigger. Default: - no name is provided

Return type:

ITriggerRef

Returns:

a reference to the created trigger.

add_scheduled_trigger(id, *, schedule, start_on_creation=None, actions, description=None, name=None)

Add a scheduled trigger to the workflow.

Parameters:

  • id (str)

  • schedule (TriggerSchedule) – The schedule on which this trigger fires. Build one with {@link TriggerSchedule.daily}, {@link TriggerSchedule.weekly}, {@link TriggerSchedule.cron}, or {@link TriggerSchedule.expression}.

  • start_on_creation (Optional[bool]) – Whether to start the trigger on creation or not. Default: - false

  • actions (Sequence[Action]) – The actions initiated by this trigger.

  • description (Optional[str]) – A description for the trigger. Default: - no description

  • name (Optional[str]) – A name for the trigger. Default: - no name is provided

Return type:

ITriggerRef

Returns:

a reference to the created trigger.

apply_removal_policy(policy)

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

Parameters:

policy (RemovalPolicy)

Return type:

None

with_(*mixins)

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.

Parameters:

mixins (IMixin) – The mixins to apply.

Return type:

IConstruct

Returns:

This construct for chaining

Attributes

env

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

The tree node.

stack

The stack in which this resource is defined.

workflow_arn

The ARN of the workflow.

Attribute:

true

workflow_name

The name of the workflow.

Attribute:

true