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	awscc.databrew.recipes

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
name	string	Recipe name
region	string	AWS region.

For more information, see AWS::DataBrew::Recipe.

Methods

Name	Resource	Accessible by	Required Params
create_resource	recipes	INSERT	Name, Steps, region
delete_resource	recipes	DELETE	Identifier, region
update_resource	recipes	UPDATE	Identifier, PatchDocument, region
list_resources	recipes_list_only	SELECT	region
get_resource	recipes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual recipe.

SELECT
  region,
  description,
  name,
  steps,
  tags
FROM awscc.databrew.recipes
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all recipes in a region.

SELECT
  region,
  name
FROM awscc.databrew.recipes_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.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
            condition_expressions:
              - condition: '{{ condition }}'
                value: '{{ value }}'
                target_column: '{{ target_column }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.databrew.recipes
SET PatchDocument = string('{{ {
    "Description": description,
    "Steps": steps,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.databrew.recipes
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

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

Read

databrew:DescribeRecipe,
databrew:ListTagsForResource,
iam:ListRoles

Delete

databrew:DeleteRecipeVersion

List

databrew:ListRecipes,
iam:ListRoles

Update

databrew:UpdateRecipe,
databrew:TagResource,
databrew:UntagResource