interface IWorkflow
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.Alpha.IWorkflow |
![]() | github.com/aws/aws-cdk-go/awscdkgluealpha/v2#IWorkflow |
![]() | software.amazon.awscdk.services.glue.alpha.IWorkflow |
![]() | aws_cdk.aws_glue_alpha.IWorkflow |
![]() | @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 | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
workflow | string | The ARN of the workflow. |
workflow | string | The name of the workflow. |
env
Type:
Resource
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 |
---|---|
add | Add an custom-scheduled trigger to the workflow. |
add | Add an daily-scheduled trigger to the workflow. |
add | Add an on-demand trigger to the workflow. |
add | Add an weekly-scheduled trigger to the workflow. |
apply | Apply the given removal policy to this resource. |
addCustomScheduledTrigger(id, options)
public addCustomScheduledTrigger(id: string, options: CustomScheduledTriggerOptions): CfnTrigger
Parameters
- id
string
- options
Custom
Scheduled Trigger Options
Returns
Add an custom-scheduled trigger to the workflow.
addDailyScheduledTrigger(id, options)
public addDailyScheduledTrigger(id: string, options: DailyScheduleTriggerOptions): CfnTrigger
Parameters
- id
string
- options
Daily
Schedule Trigger Options
Returns
Add an daily-scheduled trigger to the workflow.
addOnDemandTrigger(id, options)
public addOnDemandTrigger(id: string, options: OnDemandTriggerOptions): CfnTrigger
Parameters
- id
string
- options
On
Demand Trigger Options
Returns
Add an on-demand trigger to the workflow.
addWeeklyScheduledTrigger(id, options)
public addWeeklyScheduledTrigger(id: string, options: WeeklyScheduleTriggerOptions): CfnTrigger
Parameters
- id
string
- options
Weekly
Schedule Trigger Options
Returns
Add an weekly-scheduled trigger to the workflow.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).