recipes

Creates, updates, deletes or gets a recipe resource or lists recipes in a region

Overview

Name	recipes
Type	Resource
Description	Resource schema for AWS::DataBrew::Recipe.
Id	aws.databrew.recipes

Fields

Name	Datatype	Description
description	string	Description of the recipe
name	string	Recipe name
steps	array
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Steps, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all recipes in a region.

SELECT
region,
description,
name,
steps,
tags
FROM aws.databrew.recipes
WHERE region = 'us-east-1';

Gets all properties from an individual recipe.

SELECT
region,
description,
name,
steps,
tags
FROM aws.databrew.recipes
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new recipe resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.databrew.recipes (
 Name,
 Steps,
 region
)
SELECT 
'{{ Name }}',
 '{{ Steps }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.databrew.recipes (
 Description,
 Name,
 Steps,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ Steps }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: recipe
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Steps
        value:
          - Action:
              Operation: '{{ Operation }}'
              Parameters: null
            ConditionExpressions:
              - Condition: '{{ Condition }}'
                Value: '{{ Value }}'
                TargetColumn: '{{ TargetColumn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.databrew.recipes
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the recipes resource, the following permissions are required:

Create

databrew:CreateRecipe,
databrew:TagResource,
databrew:UntagResource,
iam:PassRole

Read

databrew:DescribeRecipe,
databrew:ListTagsForResource,
iam:ListRoles

Delete

databrew:DeleteRecipeVersion

List

databrew:ListRecipes,
databrew:ListTagsForResource,
iam:ListRoles

Update

databrew:UpdateRecipe