This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DataBrew::Project
<a name="aws-resource-databrew-project"></a>

Specifies a new AWS Glue DataBrew project.

## Syntax
<a name="aws-resource-databrew-project-syntax"></a>

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

### JSON
<a name="aws-resource-databrew-project-syntax.json"></a>

```
{
  "Type" : "AWS::DataBrew::Project",
  "Properties" : {
      "[DatasetName](#cfn-databrew-project-datasetname)" : String,
      "[Name](#cfn-databrew-project-name)" : String,
      "[RecipeName](#cfn-databrew-project-recipename)" : String,
      "[RoleArn](#cfn-databrew-project-rolearn)" : String,
      "[Sample](#cfn-databrew-project-sample)" : Sample,
      "[Tags](#cfn-databrew-project-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-databrew-project-syntax.yaml"></a>

```
Type: AWS::DataBrew::Project
Properties:
  [DatasetName](#cfn-databrew-project-datasetname): String
  [Name](#cfn-databrew-project-name): String
  [RecipeName](#cfn-databrew-project-recipename): String
  [RoleArn](#cfn-databrew-project-rolearn): String
  [Sample](#cfn-databrew-project-sample): 
    Sample
  [Tags](#cfn-databrew-project-tags): 
    - Tag
```

## Properties
<a name="aws-resource-databrew-project-properties"></a>

`DatasetName`  <a name="cfn-databrew-project-datasetname"></a>
The dataset that the project is to act upon.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-databrew-project-name"></a>
The unique name of a project.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RecipeName`  <a name="cfn-databrew-project-recipename"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-databrew-project-rolearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Sample`  <a name="cfn-databrew-project-sample"></a>
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](aws-properties-databrew-project-sample.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-databrew-project-tags"></a>
Metadata tags that have been applied to the project.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-databrew-project-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-databrew-project-return-values"></a>

### Ref
<a name="aws-resource-databrew-project-return-values-ref"></a>

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
<a name="aws-resource-databrew-project--examples"></a>



### Creating projects
<a name="aws-resource-databrew-project--examples--Creating_projects"></a>

The following examples create new DataBrew projects.

#### YAML
<a name="aws-resource-databrew-project--examples--Creating_projects--yaml"></a>

```
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
<a name="aws-resource-databrew-project--examples--Creating_projects--json"></a>

```
{
    "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"
                    }
                ]
            }
        }
    }
}
```

# AWS::DataBrew::Project Sample
<a name="aws-properties-databrew-project-sample"></a>

Represents the sample size and sampling type for DataBrew to use for interactive data analysis.

## Syntax
<a name="aws-properties-databrew-project-sample-syntax"></a>

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

### JSON
<a name="aws-properties-databrew-project-sample-syntax.json"></a>

```
{
  "[Size](#cfn-databrew-project-sample-size)" : Integer,
  "[Type](#cfn-databrew-project-sample-type)" : String
}
```

### YAML
<a name="aws-properties-databrew-project-sample-syntax.yaml"></a>

```
  [Size](#cfn-databrew-project-sample-size): Integer
  [Type](#cfn-databrew-project-sample-type): String
```

## Properties
<a name="aws-properties-databrew-project-sample-properties"></a>

`Size`  <a name="cfn-databrew-project-sample-size"></a>
The number of rows in the sample.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-databrew-project-sample-type"></a>
The way in which DataBrew obtains rows from a dataset.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `FIRST_N | LAST_N | RANDOM`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DataBrew::Project Tag
<a name="aws-properties-databrew-project-tag"></a>

<a name="aws-properties-databrew-project-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Project](aws-resource-databrew-project.md).

## Syntax
<a name="aws-properties-databrew-project-tag-syntax"></a>

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

### JSON
<a name="aws-properties-databrew-project-tag-syntax.json"></a>

```
{
  "[Key](#cfn-databrew-project-tag-key)" : String,
  "[Value](#cfn-databrew-project-tag-value)" : String
}
```

### YAML
<a name="aws-properties-databrew-project-tag-syntax.yaml"></a>

```
  [Key](#cfn-databrew-project-tag-key): String
  [Value](#cfn-databrew-project-tag-value): String
```

## Properties
<a name="aws-properties-databrew-project-tag-properties"></a>

`Key`  <a name="cfn-databrew-project-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-databrew-project-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)