AWS::DataBrew::Recipe - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
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::DataBrew::Recipe

Specifies a new Amazon Glue DataBrew transformation recipe.

Syntax

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

JSON

{
  "Type" : "AWS::DataBrew::Recipe",
  "Properties" : {
      "Description" : String,
      "Name" : String,
      "Steps" : [ RecipeStep, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataBrew::Recipe
Properties:
  Description: String
  Name: String
  Steps: 
    - RecipeStep
  Tags: 
    - Tag

Properties

Description

The description of the recipe.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

Name

The unique name for the recipe.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Steps

A list of steps that are defined by the recipe.

Required: Yes

Type: Array of RecipeStep

Update requires: No interruption

Tags

Metadata tags that have been applied to the recipe.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "myRecipe" }

For an Amazon Glue DataBrew recipe named myRecipe, Ref returns the name of the recipe.

Examples

Creating recipes

The following examples create new DataBrew recipes.

YAML


Resources:
  TestDataBrewRecipe:
    Type: AWS::DataBrew::Recipe
    Properties:
      Name: recipe-name
      Description: This is the recipe description.
      Steps:
      - Action:
          Operation: EXTRACT_PATTERN
          Parameters:
            SourceColumn: Consulate
            Pattern: A
            TargetColumn: extract_pattern
        ConditionExpressions:
        - Condition : LESS_THAN_EQUAL
          Value: 5
          TargetColumn: Target
      Tags: [{Key: key00AtCreate, Value: value001AtCreate}]

JSON


{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "This CloudFormation template specifies a DataBrew Recipe",
    "Resources": {
        "MyDataBrewRecipe": {
            "Type": "AWS::DataBrew::Recipe",
            "Properties": {
              "Name": "na-recipe-cf-test",
              "Description": "This is the recipe description.",
              "Steps":[
                {
                  "Action":{
                    "Operation":"EXTRACT_PATTERN",
                    "Parameters":{
                      "SourceColumn": "Consulate",
                      "Pattern": "A",
                      "TargetColumn": "extract_pattern"
                  }
                },
                  "ConditionExpressions":[
                    {
                      "Condition": "LESS_THAN",
                      "ConditionValue": "2",
                      "TargetColumn": "target"
                    },
                    {
                      "Condition": "GREATER_THAN",
                      "Value": "0",
                      "TargetColumn": "target"
                    }
                  ]
                }
              ],
              "Tags": [
                    {
                        "Key": "key00AtCreate",
                        "Value": "value001AtCreate"
                    }
                ]
            }
        }
    }
}