WorkflowBase

class aws_cdk.aws_glue_alpha.WorkflowBase(scope, id, *, account=None, environment_from_arn=None, physical_name=None, region=None)

Bases: Resource

(experimental) Base abstract class for Workflow.

See:

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

Stability:

experimental

Parameters:

  • scope (Construct)

  • id (str)

  • account (Optional[str]) – The AWS account ID this resource belongs to. Default: - the resource is in the same account as the stack it belongs to

  • environment_from_arn (Optional[str]) – ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either account or region. Default: - take environment from account, region parameters, or use Stack environment.

  • physical_name (Optional[str]) – The value passed in by users to the physical name prop of the resource. - undefined implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. Default: - The physical name will be allocated by CloudFormation at deployment time

  • region (Optional[str]) – The AWS region this resource belongs to. Default: - the resource is in the same region as the stack it belongs to

Methods

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

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

Parameters:

  • id (str) – The id of the trigger.

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

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

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

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.

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

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

Parameters:

  • id (str) – The id of the trigger.

  • schedule (TriggerSchedule) – (experimental) The custom schedule for the trigger.

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

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

Stability:

experimental

Throws:

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

add_daily_scheduled_trigger(id, *, start_on_creation=None, actions, description=None, name=None)

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

Parameters:

  • id (str) – The id of the trigger.

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

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

Stability:

experimental

Throws:

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

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

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

Parameters:

  • id (str) – The id of the trigger.

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

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

Stability:

experimental

Throws:

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

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

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

Parameters:

  • id (str) – The id of the trigger.

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

Stability:

experimental

Throws:

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

add_weekly_scheduled_trigger(id, *, start_on_creation=None, actions, description=None, name=None)

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

Parameters:

  • id (str) – The id of the trigger.

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

  • actions (Sequence[Union[Action, Dict[str, Any]]]) – (experimental) The actions initiated by this trigger.

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

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

Return type:

CfnTrigger

Returns:

The created CfnTrigger resource.

Stability:

experimental

Throws:

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

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

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

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

The tree node.

stack

The stack in which this resource is defined.

workflow_arn

(experimental) The ARN of the workflow.

Stability:

experimental

workflow_name

(experimental) The name of the workflow.

Stability:

experimental

Static Methods

classmethod extract_name_from_arn(scope, workflow_arn)

(experimental) Extract workflowName from arn.

Parameters:
Stability:

experimental

Return type:

str

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool