AWS::Glue::Workflow - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Glue::Workflow

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Glue::Workflow",
  "Properties" : {
      "DefaultRunProperties" : Json,
      "Description" : String,
      "MaxConcurrentRuns" : Integer,
      "Name" : String,
      "Tags" : Json
    }
}

YAML

Type: AWS::Glue::Workflow
Properties: 
  DefaultRunProperties: Json
  Description: String
  MaxConcurrentRuns: Integer
  Name: String
  Tags: Json

Properties

DefaultRunProperties

A collection of properties to be used as part of each execution of the workflow

Required: No

Type: Json

Update requires: No interruption

Description

A description of the workflow

Required: No

Type: String

Update requires: No interruption

MaxConcurrentRuns

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.

Required: No

Type: Integer

Update requires: No interruption

Name

The name of the workflow representing the flow

Required: No

Type: String

Update requires: Replacement

Tags

The tags to use with this workflow.

Required: No

Type: Json

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the workflow name.

For more information about using the Reffunction, see Ref.