projects

Creates, updates, deletes or gets a project resource or lists projects in a region

Overview

Name	projects
Type	Resource
Description	Resource schema for AWS::DataBrew::Project.
Id	aws.databrew.projects

Fields

Name	Datatype	Description
dataset_name	string	Dataset name
name	string	Project name
recipe_name	string	Recipe name
role_arn	string	Role arn
sample	object	Sample
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DatasetName, Name, RecipeName, RoleArn, 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 projects in a region.

SELECT
region,
dataset_name,
name,
recipe_name,
role_arn,
sample,
tags
FROM aws.databrew.projects
WHERE region = 'us-east-1';

Gets all properties from an individual project.

SELECT
region,
dataset_name,
name,
recipe_name,
role_arn,
sample,
tags
FROM aws.databrew.projects
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.databrew.projects (
 DatasetName,
 Name,
 RecipeName,
 RoleArn,
 region
)
SELECT 
'{{ DatasetName }}',
 '{{ Name }}',
 '{{ RecipeName }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.databrew.projects (
 DatasetName,
 Name,
 RecipeName,
 RoleArn,
 Sample,
 Tags,
 region
)
SELECT 
 '{{ DatasetName }}',
 '{{ Name }}',
 '{{ RecipeName }}',
 '{{ RoleArn }}',
 '{{ Sample }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project
    props:
      - name: DatasetName
        value: '{{ DatasetName }}'
      - name: Name
        value: '{{ Name }}'
      - name: RecipeName
        value: '{{ RecipeName }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Sample
        value:
          Size: '{{ Size }}'
          Type: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

databrew:CreateProject,
databrew:TagResource,
databrew:UntagResource,
iam:PassRole

Read

databrew:DescribeProject,
databrew:ListTagsForResource,
iam:ListRoles

Update

databrew:UpdateProject,
iam:PassRole

Delete

databrew:DeleteProject

List

databrew:ListProjects,
databrew:ListTagsForResource,
iam:ListRoles