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

Fields

get (all properties)

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.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	projects	INSERT	DatasetName, Name, RecipeName, RoleArn, region
delete_resource	projects	DELETE	Identifier, region
update_resource	projects	UPDATE	Identifier, PatchDocument, region
list_resources	projects_list_only	SELECT	region
get_resource	projects	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual project.

SELECT
  region,
  dataset_name,
  name,
  recipe_name,
  role_arn,
  sample,
  tags
FROM awscc.databrew.projects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all projects in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.databrew.projects (
  DatasetName,
  Name,
  RecipeName,
  RoleArn,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ name }}',
  '{{ recipe_name }}',
  '{{ role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.databrew.projects (
  DatasetName,
  Name,
  RecipeName,
  RoleArn,
  Sample,
  Tags,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ name }}',
  '{{ recipe_name }}',
  '{{ role_arn }}',
  '{{ 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: dataset_name
        value: '{{ dataset_name }}'
      - name: name
        value: '{{ name }}'
      - name: recipe_name
        value: '{{ recipe_name }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: sample
        value:
          size: '{{ size }}'
          type: '{{ type }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.databrew.projects
SET PatchDocument = string('{{ {
    "DatasetName": dataset_name,
    "RecipeName": recipe_name,
    "RoleArn": role_arn,
    "Sample": sample,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

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

Permissions

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

Create

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

Read

databrew:DescribeProject,
iam:ListRoles

Update

databrew:UpdateProject,
databrew:TagResource,
databrew:UntagResource,
iam:PassRole

Delete

databrew:DeleteProject

List

databrew:ListProjects,
databrew:ListTagsForResource,
iam:ListRoles