AWS::DataBrew::Project - AWS CloudFormation (original) (raw)

Specifies a new AWS Glue DataBrew project.

Syntax

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

JSON

{
  "Type" : "AWS::DataBrew::Project",
  "Properties" : {
      "DatasetName" : String,
      "Name" : String,
      "RecipeName" : String,
      "RoleArn" : String,
      "Sample" : Sample,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataBrew::Project
Properties:
  DatasetName: String
  Name: String
  RecipeName: String
  RoleArn: String
  Sample: 
    Sample
  Tags: 
    - Tag

Properties

DatasetName

The dataset that the project is to act upon.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Name

The unique name of a project.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

RecipeName

The name of a recipe that will be developed during a project session.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of the role that will be assumed for this project.

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

Sample

The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.

Required: No

Type: Sample

Update requires: No interruption

Tags

Metadata tags that have been applied to the project.

Required: No

Type: Array of Tag

Update requires: No interruption

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": "myProject" }

For an AWS Glue DataBrew project named myProject,Ref returns the name of the project.

Examples

Creating projects

The following examples create new DataBrew projects.

YAML

Resources:
  TestDataBrewProject:
    Type: AWS::DataBrew::Project
    Properties:
      Name: project-name
      RecipeName: recipe-name
      DatasetName: dataset-name
      RoleArn: arn:aws:iam::12345678910:role/PassRoleAdmin
      Sample:
        Size: 500
        Type: LAST_N
      

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "This CloudFormation template specifies a DataBrew Project",
    "Resources": {
        "MyDataBrewProject": {
            "Type": "AWS::DataBrew::Project",
            "Properties": {
                "Name": "test-project",
                "RecipeName": "test-project-recipe",
                "DatasetName": "test-dataset",
                "RoleArn": "arn:aws:iam::1234567891011:role/PassRoleAdmin",
                "Sample": {
                    "Size": 500,
                    "Type": "LAST_N"
                },
                "Tags": [
                    {
                        "Key": "key00AtCreate",
                        "Value": "value001AtCreate"
                    }
                ]
            }
        }
    }
}