Package software.amazon.awscdk.services.glue

Class CfnWorkflow

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnWorkflow
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.524Z") @Stability(Stable) public class CfnWorkflow extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::Workflow.

The AWS::Glue::Workflow is an AWS Glue resource type that manages AWS Glue workflows. A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue . Using a workflow, you can design a complex multi-job extract, transform, and load (ETL) activity that AWS Glue can execute and track as single entity.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object defaultRunProperties;
 Object tags;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .defaultRunProperties(defaultRunProperties)
         .description("description")
         .maxConcurrentRuns(123)
         .name("name")
         .tags(tags)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkflow

      @Stability(Stable) public CfnWorkflow(@NotNull Construct scope, @NotNull String id, @Nullable CfnWorkflowProps props)
      Create a new AWS::Glue::Workflow.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnWorkflow

      @Stability(Stable) public CfnWorkflow(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Glue::Workflow.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to use with this workflow.

    • getDefaultRunProperties

      @Stability(Stable) @NotNull public Object getDefaultRunProperties()
      A collection of properties to be used as part of each execution of the workflow.

    • setDefaultRunProperties

      @Stability(Stable) public void setDefaultRunProperties(@NotNull Object value)
      A collection of properties to be used as part of each execution of the workflow.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the workflow.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the workflow.

    • getMaxConcurrentRuns

      @Stability(Stable) @Nullable public Number getMaxConcurrentRuns()
      You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.

      If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

    • setMaxConcurrentRuns

      @Stability(Stable) public void setMaxConcurrentRuns(@Nullable Number value)
      You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.

      If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the workflow representing the flow.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the workflow representing the flow.