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::Dataset
<a name="aws-resource-databrew-dataset"></a>

Specifies a new DataBrew dataset.

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

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

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

```
{
  "Type" : "AWS::DataBrew::Dataset",
  "Properties" : {
      "[Format](#cfn-databrew-dataset-format)" : String,
      "[FormatOptions](#cfn-databrew-dataset-formatoptions)" : FormatOptions,
      "[Input](#cfn-databrew-dataset-input)" : Input,
      "[Name](#cfn-databrew-dataset-name)" : String,
      "[PathOptions](#cfn-databrew-dataset-pathoptions)" : PathOptions,
      "[Source](#cfn-databrew-dataset-source)" : String,
      "[Tags](#cfn-databrew-dataset-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::DataBrew::Dataset
Properties:
  [Format](#cfn-databrew-dataset-format): String
  [FormatOptions](#cfn-databrew-dataset-formatoptions): 
    FormatOptions
  [Input](#cfn-databrew-dataset-input): 
    Input
  [Name](#cfn-databrew-dataset-name): String
  [PathOptions](#cfn-databrew-dataset-pathoptions): 
    PathOptions
  [Source](#cfn-databrew-dataset-source): String
  [Tags](#cfn-databrew-dataset-tags): 
    - Tag
```

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

`Format`  <a name="cfn-databrew-dataset-format"></a>
The file format of a dataset that is created from an Amazon S3 file or folder.  
*Required*: No  
*Type*: String  
*Allowed values*: `CSV | JSON | PARQUET | EXCEL | ORC`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FormatOptions`  <a name="cfn-databrew-dataset-formatoptions"></a>
A set of options that define how DataBrew interprets the data in the dataset.  
*Required*: No  
*Type*: [FormatOptions](aws-properties-databrew-dataset-formatoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Input`  <a name="cfn-databrew-dataset-input"></a>
Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3.  
*Required*: Yes  
*Type*: [Input](aws-properties-databrew-dataset-input.md)  
*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-dataset-name"></a>
The unique name of the dataset.  
*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)

`PathOptions`  <a name="cfn-databrew-dataset-pathoptions"></a>
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.  
*Required*: No  
*Type*: [PathOptions](aws-properties-databrew-dataset-pathoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Source`  <a name="cfn-databrew-dataset-source"></a>
The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog.  
*Required*: No  
*Type*: String  
*Allowed values*: `S3 | DATA-CATALOG | DATABASE`  
*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-dataset-tags"></a>
Metadata tags that have been applied to the dataset.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-databrew-dataset-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-dataset-return-values"></a>

### Ref
<a name="aws-resource-databrew-dataset-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": "myDataset" }` 

For an AWS Glue DataBrew dataset named `myDataset`, `Ref` returns the name of the dataset. 

## Examples
<a name="aws-resource-databrew-dataset--examples"></a>



### Creating datasets
<a name="aws-resource-databrew-dataset--examples--Creating_datasets"></a>

The following examples create new DataBrew datasets.

#### YAML
<a name="aws-resource-databrew-dataset--examples--Creating_datasets--yaml"></a>

```
Resources:
  TestDataBrewDataset:
    Type: AWS::DataBrew::Dataset
    Properties:
      Name: dataset-name
      Input:
        S3InputDefinition:
          Bucket: !Join [ '', ['databrew-cfn-integration-tests-', !Ref 'AWS::Region', '-', !Ref 'AWS::AccountId' ] ]
          Key: cocktails.json
      FormatOptions:
        Json:
          MultiLine: True
```

#### JSON
<a name="aws-resource-databrew-dataset--examples--Creating_datasets--json"></a>

```
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "This CloudFormation template specifies a DataBrew Dataset",
    "Resources": {
    "TestDataBrewDataset": {
      "Type": "AWS::DataBrew::Dataset",
      "Properties": {
        "Name": "cf-test-dataset1",
        "Input": {
          "S3InputDefinition": {
            "Bucket": "test-location",
            "Key": "test.xlsx"
          }
        },
        "FormatOptions": {
          "Excel": {
            "SheetNames": ["test"]
          }
        },
        "Tags": [
                    {
                        "Key": "key00AtCreate",
                        "Value": "value001AtCreate"
                    }
                ]
      }
    }
  }
}
```