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 Glue DataBrew **Resource types** + [AWS::DataBrew::Dataset](aws-resource-databrew-dataset.md) + [AWS::DataBrew::Job](aws-resource-databrew-job.md) + [AWS::DataBrew::Project](aws-resource-databrew-project.md) + [AWS::DataBrew::Recipe](aws-resource-databrew-recipe.md) + [AWS::DataBrew::Ruleset](aws-resource-databrew-ruleset.md) + [AWS::DataBrew::Schedule](aws-resource-databrew-schedule.md) # AWS::DataBrew::Dataset Specifies a new DataBrew dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "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 ``` 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 `Format` 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 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` 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` 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 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` 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` 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 ### Ref 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 ### Creating datasets The following examples create new DataBrew datasets. #### YAML ``` 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 ``` { "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" } ] } } } } ``` # AWS::DataBrew::Dataset CsvOptions Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Delimiter](#cfn-databrew-dataset-csvoptions-delimiter)" : String, "[HeaderRow](#cfn-databrew-dataset-csvoptions-headerrow)" : Boolean } ``` ### YAML ``` [Delimiter](#cfn-databrew-dataset-csvoptions-delimiter): String [HeaderRow](#cfn-databrew-dataset-csvoptions-headerrow): Boolean ``` ## Properties `Delimiter` A single character that specifies the delimiter being used in the CSV file. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HeaderRow` A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset DatabaseInputDefinition Connection information for dataset input files stored in a database. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseTableName](#cfn-databrew-dataset-databaseinputdefinition-databasetablename)" : String, "[GlueConnectionName](#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname)" : String, "[QueryString](#cfn-databrew-dataset-databaseinputdefinition-querystring)" : String, "[TempDirectory](#cfn-databrew-dataset-databaseinputdefinition-tempdirectory)" : S3Location } ``` ### YAML ``` [DatabaseTableName](#cfn-databrew-dataset-databaseinputdefinition-databasetablename): String [GlueConnectionName](#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname): String [QueryString](#cfn-databrew-dataset-databaseinputdefinition-querystring): String [TempDirectory](#cfn-databrew-dataset-databaseinputdefinition-tempdirectory): S3Location ``` ## Properties `DatabaseTableName` The table within the target database. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlueConnectionName` The AWS Glue Connection that stores the connection information for the target database. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QueryString` Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TempDirectory` An Amazon location that AWS Glue Data Catalog can use as a temporary directory. *Required*: No *Type*: [S3Location](aws-properties-databrew-dataset-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset DataCatalogInputDefinition Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CatalogId](#cfn-databrew-dataset-datacataloginputdefinition-catalogid)" : String, "[DatabaseName](#cfn-databrew-dataset-datacataloginputdefinition-databasename)" : String, "[TableName](#cfn-databrew-dataset-datacataloginputdefinition-tablename)" : String, "[TempDirectory](#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory)" : S3Location } ``` ### YAML ``` [CatalogId](#cfn-databrew-dataset-datacataloginputdefinition-catalogid): String [DatabaseName](#cfn-databrew-dataset-datacataloginputdefinition-databasename): String [TableName](#cfn-databrew-dataset-datacataloginputdefinition-tablename): String [TempDirectory](#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory): S3Location ``` ## Properties `CatalogId` The unique identifier of the AWS account that holds the Data Catalog that stores the data. *Required*: No *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) `DatabaseName` The name of a database in the Data Catalog. *Required*: No *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) `TableName` The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset. *Required*: No *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) `TempDirectory` An Amazon location that AWS Glue Data Catalog can use as a temporary directory. *Required*: No *Type*: [S3Location](aws-properties-databrew-dataset-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset DatasetParameter Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CreateColumn](#cfn-databrew-dataset-datasetparameter-createcolumn)" : Boolean, "[DatetimeOptions](#cfn-databrew-dataset-datasetparameter-datetimeoptions)" : DatetimeOptions, "[Filter](#cfn-databrew-dataset-datasetparameter-filter)" : FilterExpression, "[Name](#cfn-databrew-dataset-datasetparameter-name)" : String, "[Type](#cfn-databrew-dataset-datasetparameter-type)" : String } ``` ### YAML ``` [CreateColumn](#cfn-databrew-dataset-datasetparameter-createcolumn): Boolean [DatetimeOptions](#cfn-databrew-dataset-datasetparameter-datetimeoptions): DatetimeOptions [Filter](#cfn-databrew-dataset-datasetparameter-filter): FilterExpression [Name](#cfn-databrew-dataset-datasetparameter-name): String [Type](#cfn-databrew-dataset-datasetparameter-type): String ``` ## Properties `CreateColumn` Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatetimeOptions` Additional parameter options such as a format and a timezone. Required for datetime parameters. *Required*: No *Type*: [DatetimeOptions](aws-properties-databrew-dataset-datetimeoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Filter` The optional filter expression structure to apply additional matching criteria to the parameter. *Required*: No *Type*: [FilterExpression](aws-properties-databrew-dataset-filterexpression.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the parameter that is used in the dataset's Amazon S3 path. *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) `Type` The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'. *Required*: Yes *Type*: String *Allowed values*: `String | Number | Datetime` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset DatetimeOptions Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Format](#cfn-databrew-dataset-datetimeoptions-format)" : String, "[LocaleCode](#cfn-databrew-dataset-datetimeoptions-localecode)" : String, "[TimezoneOffset](#cfn-databrew-dataset-datetimeoptions-timezoneoffset)" : String } ``` ### YAML ``` [Format](#cfn-databrew-dataset-datetimeoptions-format): String [LocaleCode](#cfn-databrew-dataset-datetimeoptions-localecode): String [TimezoneOffset](#cfn-databrew-dataset-datetimeoptions-timezoneoffset): String ``` ## Properties `Format` Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm". *Required*: Yes *Type*: String *Minimum*: `2` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocaleCode` Optional value for a non-US locale code, needed for correct interpretation of some date formats. *Required*: No *Type*: String *Pattern*: `^[A-Za-z0-9_\.#@\-]+$` *Minimum*: `2` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimezoneOffset` Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed. *Required*: No *Type*: String *Pattern*: `^(Z|[-+](\d|\d{2}|\d{2}:?\d{2}))$` *Minimum*: `1` *Maximum*: `6` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset ExcelOptions Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[HeaderRow](#cfn-databrew-dataset-exceloptions-headerrow)" : Boolean, "[SheetIndexes](#cfn-databrew-dataset-exceloptions-sheetindexes)" : [ Integer, ... ], "[SheetNames](#cfn-databrew-dataset-exceloptions-sheetnames)" : [ String, ... ] } ``` ### YAML ``` [HeaderRow](#cfn-databrew-dataset-exceloptions-headerrow): Boolean [SheetIndexes](#cfn-databrew-dataset-exceloptions-sheetindexes): - Integer [SheetNames](#cfn-databrew-dataset-exceloptions-sheetnames): - String ``` ## Properties `HeaderRow` A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SheetIndexes` One or more sheet numbers in the Excel file that will be included in the dataset. *Required*: No *Type*: Array of Integer *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SheetNames` One or more named sheets in the Excel file that will be included in the dataset. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset FilesLimit Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxFiles](#cfn-databrew-dataset-fileslimit-maxfiles)" : Integer, "[Order](#cfn-databrew-dataset-fileslimit-order)" : String, "[OrderedBy](#cfn-databrew-dataset-fileslimit-orderedby)" : String } ``` ### YAML ``` [MaxFiles](#cfn-databrew-dataset-fileslimit-maxfiles): Integer [Order](#cfn-databrew-dataset-fileslimit-order): String [OrderedBy](#cfn-databrew-dataset-fileslimit-orderedby): String ``` ## Properties `MaxFiles` The number of Amazon S3 files to select. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Order` A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING. *Required*: No *Type*: String *Allowed values*: `ASCENDING | DESCENDING` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrderedBy` A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST\$1MODIFIED\$1DATE as a sorting criteria. Currently it's the only allowed value. *Required*: No *Type*: String *Allowed values*: `LAST_MODIFIED_DATE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset FilterExpression Represents a structure for defining parameter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-databrew-dataset-filterexpression-expression)" : String, "[ValuesMap](#cfn-databrew-dataset-filterexpression-valuesmap)" : [ FilterValue, ... ] } ``` ### YAML ``` [Expression](#cfn-databrew-dataset-filterexpression-expression): String [ValuesMap](#cfn-databrew-dataset-filterexpression-valuesmap): - FilterValue ``` ## Properties `Expression` The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts\$1with :prefix1 or starts\$1with :prefix2) and (ends\$1with :suffix1 or ends\$1with :suffix2)". Substitution variables should start with ':' symbol. *Required*: Yes *Type*: String *Pattern*: `^[><0-9A-Za-z_.,:)(!= ]+$` *Minimum*: `4` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValuesMap` The map of substitution variable names to their values used in this filter expression. *Required*: Yes *Type*: Array of [FilterValue](aws-properties-databrew-dataset-filtervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset FilterValue Represents a single entry in the `ValuesMap` of a `FilterExpression`. A `FilterValue` associates the name of a substitution variable in an expression to its value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-databrew-dataset-filtervalue-value)" : String, "[ValueReference](#cfn-databrew-dataset-filtervalue-valuereference)" : String } ``` ### YAML ``` [Value](#cfn-databrew-dataset-filtervalue-value): String [ValueReference](#cfn-databrew-dataset-filtervalue-valuereference): String ``` ## Properties `Value` The value to be associated with the substitution variable. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueReference` The substitution variable reference. *Required*: Yes *Type*: String *Pattern*: `^:[A-Za-z0-9_]+$` *Minimum*: `2` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset FormatOptions Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Csv](#cfn-databrew-dataset-formatoptions-csv)" : CsvOptions, "[Excel](#cfn-databrew-dataset-formatoptions-excel)" : ExcelOptions, "[Json](#cfn-databrew-dataset-formatoptions-json)" : JsonOptions } ``` ### YAML ``` [Csv](#cfn-databrew-dataset-formatoptions-csv): CsvOptions [Excel](#cfn-databrew-dataset-formatoptions-excel): ExcelOptions [Json](#cfn-databrew-dataset-formatoptions-json): JsonOptions ``` ## Properties `Csv` Options that define how CSV input is to be interpreted by DataBrew. *Required*: No *Type*: [CsvOptions](aws-properties-databrew-dataset-csvoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Excel` Options that define how Excel input is to be interpreted by DataBrew. *Required*: No *Type*: [ExcelOptions](aws-properties-databrew-dataset-exceloptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Json` Options that define how JSON input is to be interpreted by DataBrew. *Required*: No *Type*: [JsonOptions](aws-properties-databrew-dataset-jsonoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset Input Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseInputDefinition](#cfn-databrew-dataset-input-databaseinputdefinition)" : DatabaseInputDefinition, "[DataCatalogInputDefinition](#cfn-databrew-dataset-input-datacataloginputdefinition)" : DataCatalogInputDefinition, "[Metadata](#cfn-databrew-dataset-input-metadata)" : Metadata, "[S3InputDefinition](#cfn-databrew-dataset-input-s3inputdefinition)" : S3Location } ``` ### YAML ``` [DatabaseInputDefinition](#cfn-databrew-dataset-input-databaseinputdefinition): DatabaseInputDefinition [DataCatalogInputDefinition](#cfn-databrew-dataset-input-datacataloginputdefinition): DataCatalogInputDefinition [Metadata](#cfn-databrew-dataset-input-metadata): Metadata [S3InputDefinition](#cfn-databrew-dataset-input-s3inputdefinition): S3Location ``` ## Properties `DatabaseInputDefinition` Connection information for dataset input files stored in a database. *Required*: No *Type*: [DatabaseInputDefinition](aws-properties-databrew-dataset-databaseinputdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataCatalogInputDefinition` The AWS Glue Data Catalog parameters for the data. *Required*: No *Type*: [DataCatalogInputDefinition](aws-properties-databrew-dataset-datacataloginputdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Metadata` Contains additional resource information needed for specific datasets. *Required*: No *Type*: [Metadata](aws-properties-databrew-dataset-metadata.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3InputDefinition` The Amazon S3 location where the data is stored. *Required*: No *Type*: [S3Location](aws-properties-databrew-dataset-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset JsonOptions Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MultiLine](#cfn-databrew-dataset-jsonoptions-multiline)" : Boolean } ``` ### YAML ``` [MultiLine](#cfn-databrew-dataset-jsonoptions-multiline): Boolean ``` ## Properties `MultiLine` A value that specifies whether JSON input contains embedded new line characters. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset Metadata Contains additional resource information needed for specific datasets. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SourceArn](#cfn-databrew-dataset-metadata-sourcearn)" : String } ``` ### YAML ``` [SourceArn](#cfn-databrew-dataset-metadata-sourcearn): String ``` ## Properties `SourceArn` The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow. *Required*: No *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) # AWS::DataBrew::Dataset PathOptions Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilesLimit](#cfn-databrew-dataset-pathoptions-fileslimit)" : FilesLimit, "[LastModifiedDateCondition](#cfn-databrew-dataset-pathoptions-lastmodifieddatecondition)" : FilterExpression, "[Parameters](#cfn-databrew-dataset-pathoptions-parameters)" : [ PathParameter, ... ] } ``` ### YAML ``` [FilesLimit](#cfn-databrew-dataset-pathoptions-fileslimit): FilesLimit [LastModifiedDateCondition](#cfn-databrew-dataset-pathoptions-lastmodifieddatecondition): FilterExpression [Parameters](#cfn-databrew-dataset-pathoptions-parameters): - PathParameter ``` ## Properties `FilesLimit` If provided, this structure imposes a limit on a number of files that should be selected. *Required*: No *Type*: [FilesLimit](aws-properties-databrew-dataset-fileslimit.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LastModifiedDateCondition` If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3. *Required*: No *Type*: [FilterExpression](aws-properties-databrew-dataset-filterexpression.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Parameters` A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. *Required*: No *Type*: Array of [PathParameter](aws-properties-databrew-dataset-pathparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset PathParameter Represents a single entry in the path parameters of a dataset. Each `PathParameter` consists of a name and a parameter definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatasetParameter](#cfn-databrew-dataset-pathparameter-datasetparameter)" : DatasetParameter, "[PathParameterName](#cfn-databrew-dataset-pathparameter-pathparametername)" : String } ``` ### YAML ``` [DatasetParameter](#cfn-databrew-dataset-pathparameter-datasetparameter): DatasetParameter [PathParameterName](#cfn-databrew-dataset-pathparameter-pathparametername): String ``` ## Properties `DatasetParameter` The path parameter definition. *Required*: Yes *Type*: [DatasetParameter](aws-properties-databrew-dataset-datasetparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PathParameterName` The name of the path parameter. *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) # AWS::DataBrew::Dataset S3Location Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-databrew-dataset-s3location-bucket)" : String, "[BucketOwner](#cfn-databrew-dataset-s3location-bucketowner)" : String, "[Key](#cfn-databrew-dataset-s3location-key)" : String } ``` ### YAML ``` [Bucket](#cfn-databrew-dataset-s3location-bucket): String [BucketOwner](#cfn-databrew-dataset-s3location-bucketowner): String [Key](#cfn-databrew-dataset-s3location-key): String ``` ## Properties `Bucket` The Amazon S3 bucket name. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketOwner` The AWS account ID of the bucket owner. *Required*: No *Type*: String *Minimum*: `12` *Maximum*: `12` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The unique name of the object in the bucket. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1280` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Dataset Tag The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Dataset](aws-resource-databrew-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-dataset-tag-key)" : String, "[Value](#cfn-databrew-dataset-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-dataset-tag-key): String [Value](#cfn-databrew-dataset-tag-value): String ``` ## Properties `Key` 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` 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) # AWS::DataBrew::Job Specifies a new DataBrew job. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataBrew::Job", "Properties" : { "[DatabaseOutputs](#cfn-databrew-job-databaseoutputs)" : [ DatabaseOutput, ... ], "[DataCatalogOutputs](#cfn-databrew-job-datacatalogoutputs)" : [ DataCatalogOutput, ... ], "[DatasetName](#cfn-databrew-job-datasetname)" : String, "[EncryptionKeyArn](#cfn-databrew-job-encryptionkeyarn)" : String, "[EncryptionMode](#cfn-databrew-job-encryptionmode)" : String, "[JobSample](#cfn-databrew-job-jobsample)" : JobSample, "[LogSubscription](#cfn-databrew-job-logsubscription)" : String, "[MaxCapacity](#cfn-databrew-job-maxcapacity)" : Integer, "[MaxRetries](#cfn-databrew-job-maxretries)" : Integer, "[Name](#cfn-databrew-job-name)" : String, "[OutputLocation](#cfn-databrew-job-outputlocation)" : OutputLocation, "[Outputs](#cfn-databrew-job-outputs)" : [ Output, ... ], "[ProfileConfiguration](#cfn-databrew-job-profileconfiguration)" : ProfileConfiguration, "[ProjectName](#cfn-databrew-job-projectname)" : String, "[Recipe](#cfn-databrew-job-recipe)" : Recipe, "[RoleArn](#cfn-databrew-job-rolearn)" : String, "[Tags](#cfn-databrew-job-tags)" : [ Tag, ... ], "[Timeout](#cfn-databrew-job-timeout)" : Integer, "[Type](#cfn-databrew-job-type)" : String, "[ValidationConfigurations](#cfn-databrew-job-validationconfigurations)" : [ ValidationConfiguration, ... ] } } ``` ### YAML ``` Type: AWS::DataBrew::Job Properties: [DatabaseOutputs](#cfn-databrew-job-databaseoutputs): - DatabaseOutput [DataCatalogOutputs](#cfn-databrew-job-datacatalogoutputs): - DataCatalogOutput [DatasetName](#cfn-databrew-job-datasetname): String [EncryptionKeyArn](#cfn-databrew-job-encryptionkeyarn): String [EncryptionMode](#cfn-databrew-job-encryptionmode): String [JobSample](#cfn-databrew-job-jobsample): JobSample [LogSubscription](#cfn-databrew-job-logsubscription): String [MaxCapacity](#cfn-databrew-job-maxcapacity): Integer [MaxRetries](#cfn-databrew-job-maxretries): Integer [Name](#cfn-databrew-job-name): String [OutputLocation](#cfn-databrew-job-outputlocation): OutputLocation [Outputs](#cfn-databrew-job-outputs): - Output [ProfileConfiguration](#cfn-databrew-job-profileconfiguration): ProfileConfiguration [ProjectName](#cfn-databrew-job-projectname): String [Recipe](#cfn-databrew-job-recipe): Recipe [RoleArn](#cfn-databrew-job-rolearn): String [Tags](#cfn-databrew-job-tags): - Tag [Timeout](#cfn-databrew-job-timeout): Integer [Type](#cfn-databrew-job-type): String [ValidationConfigurations](#cfn-databrew-job-validationconfigurations): - ValidationConfiguration ``` ## Properties `DatabaseOutputs` Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. *Required*: No *Type*: Array of [DatabaseOutput](aws-properties-databrew-job-databaseoutput.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataCatalogOutputs` One or more artifacts that represent the AWS Glue Data Catalog output from running the job. *Required*: No *Type*: Array of [DataCatalogOutput](aws-properties-databrew-job-datacatalogoutput.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatasetName` A dataset that the job is to process. *Required*: No *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) `EncryptionKeyArn` The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) *Required*: No *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) `EncryptionMode` The encryption mode for the job, which can be one of the following: + `SSE-KMS` - Server-side encryption with keys managed by AWS KMS. + `SSE-S3` - Server-side encryption with keys managed by Amazon S3. *Required*: No *Type*: String *Allowed values*: `SSE-KMS | SSE-S3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JobSample` A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM\$1ROWS for the mode parameter and 20,000 for the size parameter. *Required*: No *Type*: [JobSample](aws-properties-databrew-job-jobsample.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogSubscription` The current status of Amazon CloudWatch logging for the job. *Required*: No *Type*: String *Allowed values*: `ENABLE | DISABLE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxCapacity` The maximum number of nodes that can be consumed when the job processes data. *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxRetries` The maximum number of times to retry the job after a job run fails. *Required*: No *Type*: Integer *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The unique name of the job. *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) `OutputLocation` The location in Amazon S3 where the job writes its output. *Required*: No *Type*: [OutputLocation](aws-properties-databrew-job-outputlocation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Outputs` One or more artifacts that represent output from running the job. *Required*: No *Type*: Array of [Output](aws-properties-databrew-job-output.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProfileConfiguration` Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. *Required*: No *Type*: [ProfileConfiguration](aws-properties-databrew-job-profileconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectName` The name of the project that the job is associated with. *Required*: No *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) `Recipe` A series of data transformation steps that the job runs. *Required*: No *Type*: [Recipe](aws-properties-databrew-job-recipe.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of the role to be assumed for this job. *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) `Tags` Metadata tags that have been applied to the job. *Required*: No *Type*: Array of [Tag](aws-properties-databrew-job-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Timeout` The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`. *Required*: No *Type*: Integer *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The job type of the job, which must be one of the following: + `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. + `RECIPE` - A job to apply one or more transformations to a dataset. *Required*: Yes *Type*: String *Allowed values*: `PROFILE | RECIPE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ValidationConfigurations` List of validation configurations that are applied to the profile job. *Required*: No *Type*: Array of [ValidationConfiguration](aws-properties-databrew-job-validationconfiguration.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 ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{ "Ref": "myJob" }` For an AWS Glue DataBrew job named `myJob`, `Ref` returns the name of the job. ## Examples ### Creating jobs The following examples create new DataBrew profile jobs. #### YAML ``` Resources: TestDataBrewJob: Type: AWS::DataBrew::Job Properties: Type: PROFILE Name: job-name DatasetName: dataset-name RoleArn: arn:aws:iam::12345678910:role/PassRoleAdmin JobSample: Mode: 'CUSTOM_ROWS' Size: 50000 OutputLocation: Bucket: !Join [ '', ['databrew-cfn-integration-tests-', !Ref 'AWS::Region', '-', !Ref 'AWS::AccountId' ] ] Tags: [{Key: key00AtCreate, Value: value001AtCreate}] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "This CloudFormation template specifies a DataBrew Profile Job", "Resources": { "MyDataBrewProfileJob": { "Type": "AWS::DataBrew::Job", "Properties": { "Type": "PROFILE", "Name": "job-test", "DatasetName": "dataset-test", "RoleArn": "arn:aws:iam::1234567891011:role/PassRoleAdmin", "JobSample": { "Mode": "FULL_DATASET" }, "OutputLocation": { "Bucket": "test-output", "Key": "job-output.json" }, "Tags": [ { "Key": "key00AtCreate", "Value": "value001AtCreate" } ] } } } } ``` # AWS::DataBrew::Job AllowedStatistics Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Statistics](#cfn-databrew-job-allowedstatistics-statistics)" : [ String, ... ] } ``` ### YAML ``` [Statistics](#cfn-databrew-job-allowedstatistics-statistics): - String ``` ## Properties `Statistics` One or more column statistics to allow for columns that contain detected entities. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job ColumnSelector Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-databrew-job-columnselector-name)" : String, "[Regex](#cfn-databrew-job-columnselector-regex)" : String } ``` ### YAML ``` [Name](#cfn-databrew-job-columnselector-name): String [Regex](#cfn-databrew-job-columnselector-regex): String ``` ## Properties `Name` The name of a column from a dataset. *Required*: No *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) `Regex` A regular expression for selecting a column from a dataset. *Required*: No *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) # AWS::DataBrew::Job ColumnStatisticsConfiguration Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Selectors](#cfn-databrew-job-columnstatisticsconfiguration-selectors)" : [ ColumnSelector, ... ], "[Statistics](#cfn-databrew-job-columnstatisticsconfiguration-statistics)" : StatisticsConfiguration } ``` ### YAML ``` [Selectors](#cfn-databrew-job-columnstatisticsconfiguration-selectors): - ColumnSelector [Statistics](#cfn-databrew-job-columnstatisticsconfiguration-statistics): StatisticsConfiguration ``` ## Properties `Selectors` List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns. *Required*: No *Type*: Array of [ColumnSelector](aws-properties-databrew-job-columnselector.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Statistics` Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations. *Required*: Yes *Type*: [StatisticsConfiguration](aws-properties-databrew-job-statisticsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job CsvOutputOptions Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Delimiter](#cfn-databrew-job-csvoutputoptions-delimiter)" : String } ``` ### YAML ``` [Delimiter](#cfn-databrew-job-csvoutputoptions-delimiter): String ``` ## Properties `Delimiter` A single character that specifies the delimiter used to create CSV job output. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job DatabaseOutput Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseOptions](#cfn-databrew-job-databaseoutput-databaseoptions)" : DatabaseTableOutputOptions, "[DatabaseOutputMode](#cfn-databrew-job-databaseoutput-databaseoutputmode)" : String, "[GlueConnectionName](#cfn-databrew-job-databaseoutput-glueconnectionname)" : String } ``` ### YAML ``` [DatabaseOptions](#cfn-databrew-job-databaseoutput-databaseoptions): DatabaseTableOutputOptions [DatabaseOutputMode](#cfn-databrew-job-databaseoutput-databaseoutputmode): String [GlueConnectionName](#cfn-databrew-job-databaseoutput-glueconnectionname): String ``` ## Properties `DatabaseOptions` Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. *Required*: Yes *Type*: [DatabaseTableOutputOptions](aws-properties-databrew-job-databasetableoutputoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseOutputMode` The output mode to write into the database. Currently supported option: NEW\$1TABLE. *Required*: No *Type*: String *Allowed values*: `NEW_TABLE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlueConnectionName` The AWS Glue connection that stores the connection information for the target database. *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) # AWS::DataBrew::Job DatabaseTableOutputOptions Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TableName](#cfn-databrew-job-databasetableoutputoptions-tablename)" : String, "[TempDirectory](#cfn-databrew-job-databasetableoutputoptions-tempdirectory)" : S3Location } ``` ### YAML ``` [TableName](#cfn-databrew-job-databasetableoutputoptions-tablename): String [TempDirectory](#cfn-databrew-job-databasetableoutputoptions-tempdirectory): S3Location ``` ## Properties `TableName` A prefix for the name of a table DataBrew will create in the database. *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) `TempDirectory` Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results. *Required*: No *Type*: [S3Location](aws-properties-databrew-job-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job DataCatalogOutput Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CatalogId](#cfn-databrew-job-datacatalogoutput-catalogid)" : String, "[DatabaseName](#cfn-databrew-job-datacatalogoutput-databasename)" : String, "[DatabaseOptions](#cfn-databrew-job-datacatalogoutput-databaseoptions)" : DatabaseTableOutputOptions, "[Overwrite](#cfn-databrew-job-datacatalogoutput-overwrite)" : Boolean, "[S3Options](#cfn-databrew-job-datacatalogoutput-s3options)" : S3TableOutputOptions, "[TableName](#cfn-databrew-job-datacatalogoutput-tablename)" : String } ``` ### YAML ``` [CatalogId](#cfn-databrew-job-datacatalogoutput-catalogid): String [DatabaseName](#cfn-databrew-job-datacatalogoutput-databasename): String [DatabaseOptions](#cfn-databrew-job-datacatalogoutput-databaseoptions): DatabaseTableOutputOptions [Overwrite](#cfn-databrew-job-datacatalogoutput-overwrite): Boolean [S3Options](#cfn-databrew-job-datacatalogoutput-s3options): S3TableOutputOptions [TableName](#cfn-databrew-job-datacatalogoutput-tablename): String ``` ## Properties `CatalogId` The unique identifier of the AWS account that holds the Data Catalog that stores the data. *Required*: No *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) `DatabaseName` The name of a database in the Data Catalog. *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) `DatabaseOptions` Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. *Required*: No *Type*: [DatabaseTableOutputOptions](aws-properties-databrew-job-databasetableoutputoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Overwrite` A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3Options` Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. *Required*: No *Type*: [S3TableOutputOptions](aws-properties-databrew-job-s3tableoutputoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableName` The name of a table in the Data Catalog. *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) # AWS::DataBrew::Job EntityDetectorConfiguration Configuration of entity detection for a profile job. When undefined, entity detection is disabled. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllowedStatistics](#cfn-databrew-job-entitydetectorconfiguration-allowedstatistics)" : AllowedStatistics, "[EntityTypes](#cfn-databrew-job-entitydetectorconfiguration-entitytypes)" : [ String, ... ] } ``` ### YAML ``` [AllowedStatistics](#cfn-databrew-job-entitydetectorconfiguration-allowedstatistics): AllowedStatistics [EntityTypes](#cfn-databrew-job-entitydetectorconfiguration-entitytypes): - String ``` ## Properties `AllowedStatistics` Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities. *Required*: No *Type*: [AllowedStatistics](aws-properties-databrew-job-allowedstatistics.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntityTypes` Entity types to detect. Can be any of the following: + USA\$1SSN + EMAIL + USA\$1ITIN + USA\$1PASSPORT\$1NUMBER + PHONE\$1NUMBER + USA\$1DRIVING\$1LICENSE + BANK\$1ACCOUNT + CREDIT\$1CARD + IP\$1ADDRESS + MAC\$1ADDRESS + USA\$1DEA\$1NUMBER + USA\$1HCPCS\$1CODE + USA\$1NATIONAL\$1PROVIDER\$1IDENTIFIER + USA\$1NATIONAL\$1DRUG\$1CODE + USA\$1HEALTH\$1INSURANCE\$1CLAIM\$1NUMBER + USA\$1MEDICARE\$1BENEFICIARY\$1IDENTIFIER + USA\$1CPT\$1CODE + PERSON\$1NAME + DATE The Entity type group USA\$1ALL is also supported, and includes all of the above entity types except PERSON\$1NAME and DATE. *Required*: Yes *Type*: Array of String *Maximum*: `128` *Minimum*: `1 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job JobSample A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default is used. The default value is CUSTOM\$1ROWS for the mode parameter and 20,000 for the size parameter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Mode](#cfn-databrew-job-jobsample-mode)" : String, "[Size](#cfn-databrew-job-jobsample-size)" : Integer } ``` ### YAML ``` [Mode](#cfn-databrew-job-jobsample-mode): String [Size](#cfn-databrew-job-jobsample-size): Integer ``` ## Properties `Mode` A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following: + FULL\$1DATASET - The profile job is run on the entire dataset. + CUSTOM\$1ROWS - The profile job is run on the number of rows specified in the `Size` parameter. *Required*: No *Type*: String *Allowed values*: `FULL_DATASET | CUSTOM_ROWS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Size` The `Size` parameter is only required when the mode is CUSTOM\$1ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX\$1VALUE. Long.MAX\$1VALUE = 9223372036854775807 *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job Output Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CompressionFormat](#cfn-databrew-job-output-compressionformat)" : String, "[Format](#cfn-databrew-job-output-format)" : String, "[FormatOptions](#cfn-databrew-job-output-formatoptions)" : OutputFormatOptions, "[Location](#cfn-databrew-job-output-location)" : S3Location, "[MaxOutputFiles](#cfn-databrew-job-output-maxoutputfiles)" : Integer, "[Overwrite](#cfn-databrew-job-output-overwrite)" : Boolean, "[PartitionColumns](#cfn-databrew-job-output-partitioncolumns)" : [ String, ... ] } ``` ### YAML ``` [CompressionFormat](#cfn-databrew-job-output-compressionformat): String [Format](#cfn-databrew-job-output-format): String [FormatOptions](#cfn-databrew-job-output-formatoptions): OutputFormatOptions [Location](#cfn-databrew-job-output-location): S3Location [MaxOutputFiles](#cfn-databrew-job-output-maxoutputfiles): Integer [Overwrite](#cfn-databrew-job-output-overwrite): Boolean [PartitionColumns](#cfn-databrew-job-output-partitioncolumns): - String ``` ## Properties `CompressionFormat` The compression algorithm used to compress the output text of the job. *Required*: No *Type*: String *Allowed values*: `GZIP | LZ4 | SNAPPY | BZIP2 | DEFLATE | LZO | BROTLI | ZSTD | ZLIB` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Format` The data format of the output of the job. *Required*: No *Type*: String *Allowed values*: `CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML | TABLEAUHYPER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FormatOptions` Represents options that define how DataBrew formats job output files. *Required*: No *Type*: [OutputFormatOptions](aws-properties-databrew-job-outputformatoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Location` The location in Amazon S3 where the job writes its output. *Required*: Yes *Type*: [S3Location](aws-properties-databrew-job-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxOutputFiles` The maximum number of files to be generated by the job and written to the output folder. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `999` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Overwrite` A value that, if true, means that any data in the location specified for output is overwritten with new output. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PartitionColumns` The names of one or more partition columns for the output of the job. *Required*: No *Type*: Array of String *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job OutputFormatOptions Represents a set of options that define the structure of comma-separated (CSV) job output. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Csv](#cfn-databrew-job-outputformatoptions-csv)" : CsvOutputOptions } ``` ### YAML ``` [Csv](#cfn-databrew-job-outputformatoptions-csv): CsvOutputOptions ``` ## Properties `Csv` Represents a set of options that define the structure of comma-separated value (CSV) job output. *Required*: No *Type*: [CsvOutputOptions](aws-properties-databrew-job-csvoutputoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job OutputLocation The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-databrew-job-outputlocation-bucket)" : String, "[BucketOwner](#cfn-databrew-job-outputlocation-bucketowner)" : String, "[Key](#cfn-databrew-job-outputlocation-key)" : String } ``` ### YAML ``` [Bucket](#cfn-databrew-job-outputlocation-bucket): String [BucketOwner](#cfn-databrew-job-outputlocation-bucketowner): String [Key](#cfn-databrew-job-outputlocation-key): String ``` ## Properties `Bucket` The Amazon S3 bucket name. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketOwner` Property description not available. *Required*: No *Type*: String *Minimum*: `12` *Maximum*: `12` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The unique name of the object in the bucket. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job ProfileConfiguration Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnStatisticsConfigurations](#cfn-databrew-job-profileconfiguration-columnstatisticsconfigurations)" : [ ColumnStatisticsConfiguration, ... ], "[DatasetStatisticsConfiguration](#cfn-databrew-job-profileconfiguration-datasetstatisticsconfiguration)" : StatisticsConfiguration, "[EntityDetectorConfiguration](#cfn-databrew-job-profileconfiguration-entitydetectorconfiguration)" : EntityDetectorConfiguration, "[ProfileColumns](#cfn-databrew-job-profileconfiguration-profilecolumns)" : [ ColumnSelector, ... ] } ``` ### YAML ``` [ColumnStatisticsConfigurations](#cfn-databrew-job-profileconfiguration-columnstatisticsconfigurations): - ColumnStatisticsConfiguration [DatasetStatisticsConfiguration](#cfn-databrew-job-profileconfiguration-datasetstatisticsconfiguration): StatisticsConfiguration [EntityDetectorConfiguration](#cfn-databrew-job-profileconfiguration-entitydetectorconfiguration): EntityDetectorConfiguration [ProfileColumns](#cfn-databrew-job-profileconfiguration-profilecolumns): - ColumnSelector ``` ## Properties `ColumnStatisticsConfigurations` List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. *Required*: No *Type*: Array of [ColumnStatisticsConfiguration](aws-properties-databrew-job-columnstatisticsconfiguration.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatasetStatisticsConfiguration` Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. *Required*: No *Type*: [StatisticsConfiguration](aws-properties-databrew-job-statisticsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntityDetectorConfiguration` Configuration of entity detection for a profile job. When undefined, entity detection is disabled. *Required*: No *Type*: [EntityDetectorConfiguration](aws-properties-databrew-job-entitydetectorconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProfileColumns` List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. *Required*: No *Type*: Array of [ColumnSelector](aws-properties-databrew-job-columnselector.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job Recipe Represents one or more actions to be performed on a DataBrew dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-databrew-job-recipe-name)" : String, "[Version](#cfn-databrew-job-recipe-version)" : String } ``` ### YAML ``` [Name](#cfn-databrew-job-recipe-name): String [Version](#cfn-databrew-job-recipe-version): String ``` ## Properties `Name` The unique name for the recipe. *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) `Version` The identifier for the version for the recipe. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job S3Location Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-databrew-job-s3location-bucket)" : String, "[BucketOwner](#cfn-databrew-job-s3location-bucketowner)" : String, "[Key](#cfn-databrew-job-s3location-key)" : String } ``` ### YAML ``` [Bucket](#cfn-databrew-job-s3location-bucket): String [BucketOwner](#cfn-databrew-job-s3location-bucketowner): String [Key](#cfn-databrew-job-s3location-key): String ``` ## Properties `Bucket` The Amazon S3 bucket name. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketOwner` The AWS account ID of the bucket owner. *Required*: No *Type*: String *Minimum*: `12` *Maximum*: `12` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The unique name of the object in the bucket. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1280` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job S3TableOutputOptions Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Location](#cfn-databrew-job-s3tableoutputoptions-location)" : S3Location } ``` ### YAML ``` [Location](#cfn-databrew-job-s3tableoutputoptions-location): S3Location ``` ## Properties `Location` Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job. *Required*: Yes *Type*: [S3Location](aws-properties-databrew-job-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job StatisticOverride Override of a particular evaluation for a profile job. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Parameters](#cfn-databrew-job-statisticoverride-parameters)" : {Key: Value, ...}, "[Statistic](#cfn-databrew-job-statisticoverride-statistic)" : String } ``` ### YAML ``` [Parameters](#cfn-databrew-job-statisticoverride-parameters): Key: Value [Statistic](#cfn-databrew-job-statisticoverride-statistic): String ``` ## Properties `Parameters` A map that includes overrides of an evaluation’s parameters. *Required*: Yes *Type*: Object of String *Pattern*: `^[A-Za-z0-9]{1,128}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Statistic` The name of an evaluation *Required*: Yes *Type*: String *Pattern*: `^[A-Z\_]+$` *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) # AWS::DataBrew::Job StatisticsConfiguration Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludedStatistics](#cfn-databrew-job-statisticsconfiguration-includedstatistics)" : [ String, ... ], "[Overrides](#cfn-databrew-job-statisticsconfiguration-overrides)" : [ StatisticOverride, ... ] } ``` ### YAML ``` [IncludedStatistics](#cfn-databrew-job-statisticsconfiguration-includedstatistics): - String [Overrides](#cfn-databrew-job-statisticsconfiguration-overrides): - StatisticOverride ``` ## Properties `IncludedStatistics` List of included evaluations. When the list is undefined, all supported evaluations will be included. *Required*: No *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Overrides` List of overrides for evaluations. *Required*: No *Type*: Array of [StatisticOverride](aws-properties-databrew-job-statisticoverride.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Job Tag The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Job](aws-resource-databrew-job.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-job-tag-key)" : String, "[Value](#cfn-databrew-job-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-job-tag-key): String [Value](#cfn-databrew-job-tag-value): String ``` ## Properties `Key` 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` 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) # AWS::DataBrew::Job ValidationConfiguration Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RulesetArn](#cfn-databrew-job-validationconfiguration-rulesetarn)" : String, "[ValidationMode](#cfn-databrew-job-validationconfiguration-validationmode)" : String } ``` ### YAML ``` [RulesetArn](#cfn-databrew-job-validationconfiguration-rulesetarn): String [ValidationMode](#cfn-databrew-job-validationconfiguration-validationmode): String ``` ## Properties `RulesetArn` The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job. *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) `ValidationMode` Mode of data quality validation. Default mode is “CHECK\$1ALL” which verifies all rules defined in the selected ruleset. *Required*: No *Type*: String *Allowed values*: `CHECK_ALL` *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 Specifies a new AWS Glue DataBrew project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "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 ``` 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 `DatasetName` 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` 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` 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` 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` 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` 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 ### 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" } ] } } } } ``` # AWS::DataBrew::Project Sample Represents the sample size and sampling type for DataBrew to use for interactive data analysis. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Size](#cfn-databrew-project-sample-size)" : Integer, "[Type](#cfn-databrew-project-sample-type)" : String } ``` ### YAML ``` [Size](#cfn-databrew-project-sample-size): Integer [Type](#cfn-databrew-project-sample-type): String ``` ## Properties `Size` 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` 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 The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Project](aws-resource-databrew-project.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-project-tag-key)" : String, "[Value](#cfn-databrew-project-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-project-tag-key): String [Value](#cfn-databrew-project-tag-value): String ``` ## Properties `Key` 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` 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) # AWS::DataBrew::Recipe Specifies a new AWS Glue DataBrew transformation recipe. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataBrew::Recipe", "Properties" : { "[Description](#cfn-databrew-recipe-description)" : String, "[Name](#cfn-databrew-recipe-name)" : String, "[Steps](#cfn-databrew-recipe-steps)" : [ RecipeStep, ... ], "[Tags](#cfn-databrew-recipe-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataBrew::Recipe Properties: [Description](#cfn-databrew-recipe-description): String [Name](#cfn-databrew-recipe-name): String [Steps](#cfn-databrew-recipe-steps): - RecipeStep [Tags](#cfn-databrew-recipe-tags): - Tag ``` ## Properties `Description` The description of the recipe. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The unique name for the recipe. *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) `Steps` A list of steps that are defined by the recipe. *Required*: Yes *Type*: Array of [RecipeStep](aws-properties-databrew-recipe-recipestep.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata tags that have been applied to the recipe. *Required*: No *Type*: Array of [Tag](aws-properties-databrew-recipe-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 ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{ "Ref": "myRecipe" }` For an AWS Glue DataBrew recipe named `myRecipe`, `Ref` returns the name of the recipe. ## Examples ### Creating recipes The following examples create new DataBrew recipes. #### YAML ``` Resources: TestDataBrewRecipe: Type: AWS::DataBrew::Recipe Properties: Name: recipe-name Description: This is the recipe description. Steps: - Action: Operation: EXTRACT_PATTERN Parameters: SourceColumn: Consulate Pattern: A TargetColumn: extract_pattern ConditionExpressions: - Condition : LESS_THAN_EQUAL Value: 5 TargetColumn: Target Tags: [{Key: key00AtCreate, Value: value001AtCreate}] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "This CloudFormation template specifies a DataBrew Recipe", "Resources": { "MyDataBrewRecipe": { "Type": "AWS::DataBrew::Recipe", "Properties": { "Name": "na-recipe-cf-test", "Description": "This is the recipe description.", "Steps":[ { "Action":{ "Operation":"EXTRACT_PATTERN", "Parameters":{ "SourceColumn": "Consulate", "Pattern": "A", "TargetColumn": "extract_pattern" } }, "ConditionExpressions":[ { "Condition": "LESS_THAN", "ConditionValue": "2", "TargetColumn": "target" }, { "Condition": "GREATER_THAN", "Value": "0", "TargetColumn": "target" } ] } ], "Tags": [ { "Key": "key00AtCreate", "Value": "value001AtCreate" } ] } } } } ``` # AWS::DataBrew::Recipe Action Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operation](#cfn-databrew-recipe-action-operation)" : String, "[Parameters](#cfn-databrew-recipe-action-parameters)" : RecipeParameters } ``` ### YAML ``` [Operation](#cfn-databrew-recipe-action-operation): String [Parameters](#cfn-databrew-recipe-action-parameters): RecipeParameters ``` ## Properties `Operation` The name of a valid DataBrew transformation to be performed on the data. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Parameters` Contextual parameters for the transformation. *Required*: No *Type*: [RecipeParameters](aws-properties-databrew-recipe-recipeparameters.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe ConditionExpression Represents an individual condition that evaluates to true or false. Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true. If a recipe requires more than one condition, then the recipe must specify multiple `ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Condition](#cfn-databrew-recipe-conditionexpression-condition)" : String, "[TargetColumn](#cfn-databrew-recipe-conditionexpression-targetcolumn)" : String, "[Value](#cfn-databrew-recipe-conditionexpression-value)" : String } ``` ### YAML ``` [Condition](#cfn-databrew-recipe-conditionexpression-condition): String [TargetColumn](#cfn-databrew-recipe-conditionexpression-targetcolumn): String [Value](#cfn-databrew-recipe-conditionexpression-value): String ``` ## Properties `Condition` A specific condition to apply to a recipe action. For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer Guide*. *Required*: Yes *Type*: String *Pattern*: `^[A-Z\_]+$` *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) `TargetColumn` A column to apply this condition to. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` A value that the condition must evaluate to for the condition to succeed. *Required*: No *Type*: String *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe DataCatalogInputDefinition Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CatalogId](#cfn-databrew-recipe-datacataloginputdefinition-catalogid)" : String, "[DatabaseName](#cfn-databrew-recipe-datacataloginputdefinition-databasename)" : String, "[TableName](#cfn-databrew-recipe-datacataloginputdefinition-tablename)" : String, "[TempDirectory](#cfn-databrew-recipe-datacataloginputdefinition-tempdirectory)" : S3Location } ``` ### YAML ``` [CatalogId](#cfn-databrew-recipe-datacataloginputdefinition-catalogid): String [DatabaseName](#cfn-databrew-recipe-datacataloginputdefinition-databasename): String [TableName](#cfn-databrew-recipe-datacataloginputdefinition-tablename): String [TempDirectory](#cfn-databrew-recipe-datacataloginputdefinition-tempdirectory): S3Location ``` ## Properties `CatalogId` The unique identifier of the AWS account that holds the Data Catalog that stores the data. *Required*: No *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) `DatabaseName` The name of a database in the Data Catalog. *Required*: No *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) `TableName` The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset. *Required*: No *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) `TempDirectory` Represents an Amazon location where DataBrew can store intermediate results. *Required*: No *Type*: [S3Location](aws-properties-databrew-recipe-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe Input Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataCatalogInputDefinition](#cfn-databrew-recipe-input-datacataloginputdefinition)" : DataCatalogInputDefinition, "[S3InputDefinition](#cfn-databrew-recipe-input-s3inputdefinition)" : S3Location } ``` ### YAML ``` [DataCatalogInputDefinition](#cfn-databrew-recipe-input-datacataloginputdefinition): DataCatalogInputDefinition [S3InputDefinition](#cfn-databrew-recipe-input-s3inputdefinition): S3Location ``` ## Properties `DataCatalogInputDefinition` The AWS Glue Data Catalog parameters for the data. *Required*: No *Type*: [DataCatalogInputDefinition](aws-properties-databrew-recipe-datacataloginputdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3InputDefinition` The Amazon S3 location where the data is stored. *Required*: No *Type*: [S3Location](aws-properties-databrew-recipe-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe Parameters The `Parameters` property type specifies Property description not available. for an [AWS::DataBrew::Recipe](aws-resource-databrew-recipe.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Parameters](#cfn-databrew-recipe-parameters-parameters)" : RecipeParameters } ``` ### YAML ``` [Parameters](#cfn-databrew-recipe-parameters-parameters): RecipeParameters ``` ## Properties `Parameters` Contextual parameters for the transformation. *Required*: No *Type*: [RecipeParameters](aws-properties-databrew-recipe-recipeparameters.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe RecipeParameters Parameters that are used as inputs for various recipe actions. The parameters are specific to the context in which they're used. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregateFunction](#cfn-databrew-recipe-recipeparameters-aggregatefunction)" : String, "[Base](#cfn-databrew-recipe-recipeparameters-base)" : String, "[CaseStatement](#cfn-databrew-recipe-recipeparameters-casestatement)" : String, "[CategoryMap](#cfn-databrew-recipe-recipeparameters-categorymap)" : String, "[CharsToRemove](#cfn-databrew-recipe-recipeparameters-charstoremove)" : String, "[CollapseConsecutiveWhitespace](#cfn-databrew-recipe-recipeparameters-collapseconsecutivewhitespace)" : String, "[ColumnDataType](#cfn-databrew-recipe-recipeparameters-columndatatype)" : String, "[ColumnRange](#cfn-databrew-recipe-recipeparameters-columnrange)" : String, "[Count](#cfn-databrew-recipe-recipeparameters-count)" : String, "[CustomCharacters](#cfn-databrew-recipe-recipeparameters-customcharacters)" : String, "[CustomStopWords](#cfn-databrew-recipe-recipeparameters-customstopwords)" : String, "[CustomValue](#cfn-databrew-recipe-recipeparameters-customvalue)" : String, "[DatasetsColumns](#cfn-databrew-recipe-recipeparameters-datasetscolumns)" : String, "[DateAddValue](#cfn-databrew-recipe-recipeparameters-dateaddvalue)" : String, "[DateTimeFormat](#cfn-databrew-recipe-recipeparameters-datetimeformat)" : String, "[DateTimeParameters](#cfn-databrew-recipe-recipeparameters-datetimeparameters)" : String, "[DeleteOtherRows](#cfn-databrew-recipe-recipeparameters-deleteotherrows)" : String, "[Delimiter](#cfn-databrew-recipe-recipeparameters-delimiter)" : String, "[EndPattern](#cfn-databrew-recipe-recipeparameters-endpattern)" : String, "[EndPosition](#cfn-databrew-recipe-recipeparameters-endposition)" : String, "[EndValue](#cfn-databrew-recipe-recipeparameters-endvalue)" : String, "[ExpandContractions](#cfn-databrew-recipe-recipeparameters-expandcontractions)" : String, "[Exponent](#cfn-databrew-recipe-recipeparameters-exponent)" : String, "[FalseString](#cfn-databrew-recipe-recipeparameters-falsestring)" : String, "[GroupByAggFunctionOptions](#cfn-databrew-recipe-recipeparameters-groupbyaggfunctionoptions)" : String, "[GroupByColumns](#cfn-databrew-recipe-recipeparameters-groupbycolumns)" : String, "[HiddenColumns](#cfn-databrew-recipe-recipeparameters-hiddencolumns)" : String, "[IgnoreCase](#cfn-databrew-recipe-recipeparameters-ignorecase)" : String, "[IncludeInSplit](#cfn-databrew-recipe-recipeparameters-includeinsplit)" : String, "[Input](#cfn-databrew-recipe-recipeparameters-input)" : Input, "[Interval](#cfn-databrew-recipe-recipeparameters-interval)" : String, "[IsText](#cfn-databrew-recipe-recipeparameters-istext)" : String, "[JoinKeys](#cfn-databrew-recipe-recipeparameters-joinkeys)" : String, "[JoinType](#cfn-databrew-recipe-recipeparameters-jointype)" : String, "[LeftColumns](#cfn-databrew-recipe-recipeparameters-leftcolumns)" : String, "[Limit](#cfn-databrew-recipe-recipeparameters-limit)" : String, "[LowerBound](#cfn-databrew-recipe-recipeparameters-lowerbound)" : String, "[MapType](#cfn-databrew-recipe-recipeparameters-maptype)" : String, "[ModeType](#cfn-databrew-recipe-recipeparameters-modetype)" : String, "[MultiLine](#cfn-databrew-recipe-recipeparameters-multiline)" : Boolean, "[NumRows](#cfn-databrew-recipe-recipeparameters-numrows)" : String, "[NumRowsAfter](#cfn-databrew-recipe-recipeparameters-numrowsafter)" : String, "[NumRowsBefore](#cfn-databrew-recipe-recipeparameters-numrowsbefore)" : String, "[OrderByColumn](#cfn-databrew-recipe-recipeparameters-orderbycolumn)" : String, "[OrderByColumns](#cfn-databrew-recipe-recipeparameters-orderbycolumns)" : String, "[Other](#cfn-databrew-recipe-recipeparameters-other)" : String, "[Pattern](#cfn-databrew-recipe-recipeparameters-pattern)" : String, "[PatternOption1](#cfn-databrew-recipe-recipeparameters-patternoption1)" : String, "[PatternOption2](#cfn-databrew-recipe-recipeparameters-patternoption2)" : String, "[PatternOptions](#cfn-databrew-recipe-recipeparameters-patternoptions)" : String, "[Period](#cfn-databrew-recipe-recipeparameters-period)" : String, "[Position](#cfn-databrew-recipe-recipeparameters-position)" : String, "[RemoveAllPunctuation](#cfn-databrew-recipe-recipeparameters-removeallpunctuation)" : String, "[RemoveAllQuotes](#cfn-databrew-recipe-recipeparameters-removeallquotes)" : String, "[RemoveAllWhitespace](#cfn-databrew-recipe-recipeparameters-removeallwhitespace)" : String, "[RemoveCustomCharacters](#cfn-databrew-recipe-recipeparameters-removecustomcharacters)" : String, "[RemoveCustomValue](#cfn-databrew-recipe-recipeparameters-removecustomvalue)" : String, "[RemoveLeadingAndTrailingPunctuation](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingpunctuation)" : String, "[RemoveLeadingAndTrailingQuotes](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingquotes)" : String, "[RemoveLeadingAndTrailingWhitespace](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingwhitespace)" : String, "[RemoveLetters](#cfn-databrew-recipe-recipeparameters-removeletters)" : String, "[RemoveNumbers](#cfn-databrew-recipe-recipeparameters-removenumbers)" : String, "[RemoveSourceColumn](#cfn-databrew-recipe-recipeparameters-removesourcecolumn)" : String, "[RemoveSpecialCharacters](#cfn-databrew-recipe-recipeparameters-removespecialcharacters)" : String, "[RightColumns](#cfn-databrew-recipe-recipeparameters-rightcolumns)" : String, "[SampleSize](#cfn-databrew-recipe-recipeparameters-samplesize)" : String, "[SampleType](#cfn-databrew-recipe-recipeparameters-sampletype)" : String, "[SecondaryInputs](#cfn-databrew-recipe-recipeparameters-secondaryinputs)" : [ SecondaryInput, ... ], "[SecondInput](#cfn-databrew-recipe-recipeparameters-secondinput)" : String, "[SheetIndexes](#cfn-databrew-recipe-recipeparameters-sheetindexes)" : [ Integer, ... ], "[SheetNames](#cfn-databrew-recipe-recipeparameters-sheetnames)" : [ String, ... ], "[SourceColumn](#cfn-databrew-recipe-recipeparameters-sourcecolumn)" : String, "[SourceColumn1](#cfn-databrew-recipe-recipeparameters-sourcecolumn1)" : String, "[SourceColumn2](#cfn-databrew-recipe-recipeparameters-sourcecolumn2)" : String, "[SourceColumns](#cfn-databrew-recipe-recipeparameters-sourcecolumns)" : String, "[StartColumnIndex](#cfn-databrew-recipe-recipeparameters-startcolumnindex)" : String, "[StartPattern](#cfn-databrew-recipe-recipeparameters-startpattern)" : String, "[StartPosition](#cfn-databrew-recipe-recipeparameters-startposition)" : String, "[StartValue](#cfn-databrew-recipe-recipeparameters-startvalue)" : String, "[StemmingMode](#cfn-databrew-recipe-recipeparameters-stemmingmode)" : String, "[StepCount](#cfn-databrew-recipe-recipeparameters-stepcount)" : String, "[StepIndex](#cfn-databrew-recipe-recipeparameters-stepindex)" : String, "[StopWordsMode](#cfn-databrew-recipe-recipeparameters-stopwordsmode)" : String, "[Strategy](#cfn-databrew-recipe-recipeparameters-strategy)" : String, "[TargetColumn](#cfn-databrew-recipe-recipeparameters-targetcolumn)" : String, "[TargetColumnNames](#cfn-databrew-recipe-recipeparameters-targetcolumnnames)" : String, "[TargetDateFormat](#cfn-databrew-recipe-recipeparameters-targetdateformat)" : String, "[TargetIndex](#cfn-databrew-recipe-recipeparameters-targetindex)" : String, "[TimeZone](#cfn-databrew-recipe-recipeparameters-timezone)" : String, "[TokenizerPattern](#cfn-databrew-recipe-recipeparameters-tokenizerpattern)" : String, "[TrueString](#cfn-databrew-recipe-recipeparameters-truestring)" : String, "[UdfLang](#cfn-databrew-recipe-recipeparameters-udflang)" : String, "[Units](#cfn-databrew-recipe-recipeparameters-units)" : String, "[UnpivotColumn](#cfn-databrew-recipe-recipeparameters-unpivotcolumn)" : String, "[UpperBound](#cfn-databrew-recipe-recipeparameters-upperbound)" : String, "[UseNewDataFrame](#cfn-databrew-recipe-recipeparameters-usenewdataframe)" : String, "[Value](#cfn-databrew-recipe-recipeparameters-value)" : String, "[Value1](#cfn-databrew-recipe-recipeparameters-value1)" : String, "[Value2](#cfn-databrew-recipe-recipeparameters-value2)" : String, "[ValueColumn](#cfn-databrew-recipe-recipeparameters-valuecolumn)" : String, "[ViewFrame](#cfn-databrew-recipe-recipeparameters-viewframe)" : String } ``` ### YAML ``` [AggregateFunction](#cfn-databrew-recipe-recipeparameters-aggregatefunction): String [Base](#cfn-databrew-recipe-recipeparameters-base): String [CaseStatement](#cfn-databrew-recipe-recipeparameters-casestatement): String [CategoryMap](#cfn-databrew-recipe-recipeparameters-categorymap): String [CharsToRemove](#cfn-databrew-recipe-recipeparameters-charstoremove): String [CollapseConsecutiveWhitespace](#cfn-databrew-recipe-recipeparameters-collapseconsecutivewhitespace): String [ColumnDataType](#cfn-databrew-recipe-recipeparameters-columndatatype): String [ColumnRange](#cfn-databrew-recipe-recipeparameters-columnrange): String [Count](#cfn-databrew-recipe-recipeparameters-count): String [CustomCharacters](#cfn-databrew-recipe-recipeparameters-customcharacters): String [CustomStopWords](#cfn-databrew-recipe-recipeparameters-customstopwords): String [CustomValue](#cfn-databrew-recipe-recipeparameters-customvalue): String [DatasetsColumns](#cfn-databrew-recipe-recipeparameters-datasetscolumns): String [DateAddValue](#cfn-databrew-recipe-recipeparameters-dateaddvalue): String [DateTimeFormat](#cfn-databrew-recipe-recipeparameters-datetimeformat): String [DateTimeParameters](#cfn-databrew-recipe-recipeparameters-datetimeparameters): String [DeleteOtherRows](#cfn-databrew-recipe-recipeparameters-deleteotherrows): String [Delimiter](#cfn-databrew-recipe-recipeparameters-delimiter): String [EndPattern](#cfn-databrew-recipe-recipeparameters-endpattern): String [EndPosition](#cfn-databrew-recipe-recipeparameters-endposition): String [EndValue](#cfn-databrew-recipe-recipeparameters-endvalue): String [ExpandContractions](#cfn-databrew-recipe-recipeparameters-expandcontractions): String [Exponent](#cfn-databrew-recipe-recipeparameters-exponent): String [FalseString](#cfn-databrew-recipe-recipeparameters-falsestring): String [GroupByAggFunctionOptions](#cfn-databrew-recipe-recipeparameters-groupbyaggfunctionoptions): String [GroupByColumns](#cfn-databrew-recipe-recipeparameters-groupbycolumns): String [HiddenColumns](#cfn-databrew-recipe-recipeparameters-hiddencolumns): String [IgnoreCase](#cfn-databrew-recipe-recipeparameters-ignorecase): String [IncludeInSplit](#cfn-databrew-recipe-recipeparameters-includeinsplit): String [Input](#cfn-databrew-recipe-recipeparameters-input): Input [Interval](#cfn-databrew-recipe-recipeparameters-interval): String [IsText](#cfn-databrew-recipe-recipeparameters-istext): String [JoinKeys](#cfn-databrew-recipe-recipeparameters-joinkeys): String [JoinType](#cfn-databrew-recipe-recipeparameters-jointype): String [LeftColumns](#cfn-databrew-recipe-recipeparameters-leftcolumns): String [Limit](#cfn-databrew-recipe-recipeparameters-limit): String [LowerBound](#cfn-databrew-recipe-recipeparameters-lowerbound): String [MapType](#cfn-databrew-recipe-recipeparameters-maptype): String [ModeType](#cfn-databrew-recipe-recipeparameters-modetype): String [MultiLine](#cfn-databrew-recipe-recipeparameters-multiline): Boolean [NumRows](#cfn-databrew-recipe-recipeparameters-numrows): String [NumRowsAfter](#cfn-databrew-recipe-recipeparameters-numrowsafter): String [NumRowsBefore](#cfn-databrew-recipe-recipeparameters-numrowsbefore): String [OrderByColumn](#cfn-databrew-recipe-recipeparameters-orderbycolumn): String [OrderByColumns](#cfn-databrew-recipe-recipeparameters-orderbycolumns): String [Other](#cfn-databrew-recipe-recipeparameters-other): String [Pattern](#cfn-databrew-recipe-recipeparameters-pattern): String [PatternOption1](#cfn-databrew-recipe-recipeparameters-patternoption1): String [PatternOption2](#cfn-databrew-recipe-recipeparameters-patternoption2): String [PatternOptions](#cfn-databrew-recipe-recipeparameters-patternoptions): String [Period](#cfn-databrew-recipe-recipeparameters-period): String [Position](#cfn-databrew-recipe-recipeparameters-position): String [RemoveAllPunctuation](#cfn-databrew-recipe-recipeparameters-removeallpunctuation): String [RemoveAllQuotes](#cfn-databrew-recipe-recipeparameters-removeallquotes): String [RemoveAllWhitespace](#cfn-databrew-recipe-recipeparameters-removeallwhitespace): String [RemoveCustomCharacters](#cfn-databrew-recipe-recipeparameters-removecustomcharacters): String [RemoveCustomValue](#cfn-databrew-recipe-recipeparameters-removecustomvalue): String [RemoveLeadingAndTrailingPunctuation](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingpunctuation): String [RemoveLeadingAndTrailingQuotes](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingquotes): String [RemoveLeadingAndTrailingWhitespace](#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingwhitespace): String [RemoveLetters](#cfn-databrew-recipe-recipeparameters-removeletters): String [RemoveNumbers](#cfn-databrew-recipe-recipeparameters-removenumbers): String [RemoveSourceColumn](#cfn-databrew-recipe-recipeparameters-removesourcecolumn): String [RemoveSpecialCharacters](#cfn-databrew-recipe-recipeparameters-removespecialcharacters): String [RightColumns](#cfn-databrew-recipe-recipeparameters-rightcolumns): String [SampleSize](#cfn-databrew-recipe-recipeparameters-samplesize): String [SampleType](#cfn-databrew-recipe-recipeparameters-sampletype): String [SecondaryInputs](#cfn-databrew-recipe-recipeparameters-secondaryinputs): - SecondaryInput [SecondInput](#cfn-databrew-recipe-recipeparameters-secondinput): String [SheetIndexes](#cfn-databrew-recipe-recipeparameters-sheetindexes): - Integer [SheetNames](#cfn-databrew-recipe-recipeparameters-sheetnames): - String [SourceColumn](#cfn-databrew-recipe-recipeparameters-sourcecolumn): String [SourceColumn1](#cfn-databrew-recipe-recipeparameters-sourcecolumn1): String [SourceColumn2](#cfn-databrew-recipe-recipeparameters-sourcecolumn2): String [SourceColumns](#cfn-databrew-recipe-recipeparameters-sourcecolumns): String [StartColumnIndex](#cfn-databrew-recipe-recipeparameters-startcolumnindex): String [StartPattern](#cfn-databrew-recipe-recipeparameters-startpattern): String [StartPosition](#cfn-databrew-recipe-recipeparameters-startposition): String [StartValue](#cfn-databrew-recipe-recipeparameters-startvalue): String [StemmingMode](#cfn-databrew-recipe-recipeparameters-stemmingmode): String [StepCount](#cfn-databrew-recipe-recipeparameters-stepcount): String [StepIndex](#cfn-databrew-recipe-recipeparameters-stepindex): String [StopWordsMode](#cfn-databrew-recipe-recipeparameters-stopwordsmode): String [Strategy](#cfn-databrew-recipe-recipeparameters-strategy): String [TargetColumn](#cfn-databrew-recipe-recipeparameters-targetcolumn): String [TargetColumnNames](#cfn-databrew-recipe-recipeparameters-targetcolumnnames): String [TargetDateFormat](#cfn-databrew-recipe-recipeparameters-targetdateformat): String [TargetIndex](#cfn-databrew-recipe-recipeparameters-targetindex): String [TimeZone](#cfn-databrew-recipe-recipeparameters-timezone): String [TokenizerPattern](#cfn-databrew-recipe-recipeparameters-tokenizerpattern): String [TrueString](#cfn-databrew-recipe-recipeparameters-truestring): String [UdfLang](#cfn-databrew-recipe-recipeparameters-udflang): String [Units](#cfn-databrew-recipe-recipeparameters-units): String [UnpivotColumn](#cfn-databrew-recipe-recipeparameters-unpivotcolumn): String [UpperBound](#cfn-databrew-recipe-recipeparameters-upperbound): String [UseNewDataFrame](#cfn-databrew-recipe-recipeparameters-usenewdataframe): String [Value](#cfn-databrew-recipe-recipeparameters-value): String [Value1](#cfn-databrew-recipe-recipeparameters-value1): String [Value2](#cfn-databrew-recipe-recipeparameters-value2): String [ValueColumn](#cfn-databrew-recipe-recipeparameters-valuecolumn): String [ViewFrame](#cfn-databrew-recipe-recipeparameters-viewframe): String ``` ## Properties `AggregateFunction` The name of an aggregation function to apply. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Base` The number of digits used in a counting system. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CaseStatement` A case statement associated with a recipe. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CategoryMap` A category map used for one-hot encoding. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CharsToRemove` Characters to remove from a step that applies one-hot encoding or tokenization. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CollapseConsecutiveWhitespace` Remove any non-word non-punctuation character. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnDataType` The data type of the column. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnRange` A range of columns to which a step is applied. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Count` The number of times a string needs to be repeated. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomCharacters` One or more characters that can be substituted or removed, depending on the context. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomStopWords` A list of words to ignore in a step that applies word tokenization. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomValue` A list of custom values to use in a step that requires that you provide a value to finish the operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatasetsColumns` A list of the dataset columns included in a project. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DateAddValue` A value that specifies how many units of time to add or subtract for a date math operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DateTimeFormat` A date format to apply to a date. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DateTimeParameters` A set of parameters associated with a datetime. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeleteOtherRows` Determines whether unmapped rows in a categorical mapping should be deleted *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Delimiter` The delimiter to use when parsing separated values in a text file. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EndPattern` The end pattern to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EndPosition` The end position to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EndValue` The end value to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExpandContractions` A list of word contractions and what they expand to. For eample: *can't*; *cannot*; *can not*. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Exponent` The exponent to apply in an exponential operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FalseString` A value that represents `FALSE`. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GroupByAggFunctionOptions` Specifies options to apply to the `GROUP BY` used in an aggregation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GroupByColumns` The columns to use in the `GROUP BY` clause. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HiddenColumns` A list of columns to hide. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IgnoreCase` Indicates that lower and upper case letters are treated equally. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeInSplit` Indicates if this column is participating in a split transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Input` The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog. *Required*: No *Type*: [Input](aws-properties-databrew-recipe-input.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Interval` The number of characters to split by. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsText` Indicates if the content is text. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinKeys` The keys or columns involved in a join. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinType` The type of join to use, for example, `INNER JOIN`, `OUTER JOIN`, and so on. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LeftColumns` The columns on the left side of the join. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Limit` The number of times to perform `split` or `replaceBy` in a string *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LowerBound` The lower boundary for a value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MapType` The type of mappings to apply to construct a new dynamic frame. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModeType` Determines the manner in which mode value is calculated, in case there is more than one mode value. Valid values: `NONE` \$1 `AVERAGE` \$1 `MINIMUM` \$1 `MAXIMUM` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MultiLine` Specifies whether JSON input contains embedded new line characters. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumRows` The number of rows to consider in a window. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumRowsAfter` The number of rows to consider after the current row in a window *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumRowsBefore` The number of rows to consider before the current row in a window *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrderByColumn` A column to sort the results by. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrderByColumns` The columns to sort the results by. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Other` The value to assign to unmapped cells, in categorical mapping *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pattern` The pattern to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternOption1` The starting pattern to split between. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternOption2` The ending pattern to split between. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternOptions` For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. For example: `[{\"pattern\":\"1\",\"includeInSplit\":true}]` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Period` The size of the rolling window. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Position` The character index within a string *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveAllPunctuation` If `true`, removes all of the following characters: `.``.!``.,``.?` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveAllQuotes` If `true`, removes all single quotes and double quotes. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveAllWhitespace` If `true`, removes all whitespaces from the value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveCustomCharacters` If `true`, removes all chraracters specified by `CustomCharacters`. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveCustomValue` If `true`, removes all chraracters specified by `CustomValue`. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveLeadingAndTrailingPunctuation` If `true`, removes the following characters if they occur at the start or end of the value: `.``!``,``?` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveLeadingAndTrailingQuotes` If `true`, removes single quotes and double quotes from the beginning and end of the value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveLeadingAndTrailingWhitespace` If `true`, removes all whitespaces from the beginning and end of the value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveLetters` If `true`, removes all uppercase and lowercase alphabetic characters (A through Z; a through z). *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveNumbers` If `true`, removes all numeric characters (0 through 9). *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveSourceColumn` If `true`, the source column will be removed after un-nesting that column. (Used with nested column types, such as Map, Struct, or Array.) *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RemoveSpecialCharacters` If `true`, removes all of the following characters: `! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RightColumns` The columns on the right side of a join. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleSize` The number of rows in the sample. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SampleType` The sampling type to apply to the dataset. Valid values: `FIRST_N` \$1 `LAST_N` \$1 `RANDOM` *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecondaryInputs` A list of secondary inputs in a UNION transform *Required*: No *Type*: Array of [SecondaryInput](aws-properties-databrew-recipe-secondaryinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecondInput` A object value to indicate the second dataset used in a join. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SheetIndexes` One or more sheet numbers in the Excel file, which will be included in a dataset. *Required*: No *Type*: Array of Integer *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SheetNames` Oone or more named sheets in the Excel file, which will be included in a dataset. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceColumn` A source column needed for an operation, step, or transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceColumn1` A source column needed for an operation, step, or transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceColumn2` A source column needed for an operation, step, or transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceColumns` A list of source columns needed for an operation, step, or transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartColumnIndex` The index number of the first column used by an operation, step, or transform. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartPattern` The starting pattern to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartPosition` The starting position to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartValue` The starting value to locate. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StemmingMode` Indicates this operation uses stems and lemmas (base words) for word tokenization. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StepCount` The total number of transforms in this recipe. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StepIndex` The index ID of a step. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopWordsMode` Indicates this operation uses stop words as part of word tokenization. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Strategy` The resolution strategy to apply in resolving ambiguities. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetColumn` The column targeted by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetColumnNames` The names to give columns altered by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetDateFormat` The date format to convert to. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetIndex` The index number of an object that is targeted by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeZone` The current timezone that you want to use for dates. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenizerPattern` A regex expression to use when splitting text into terms, also called words or tokens. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TrueString` A value to use to represent `TRUE`. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UdfLang` The language that's used in the user-defined function. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Units` Specifies a unit of time. For example: `MINUTES`; `SECONDS`; `HOURS`; etc. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotColumn` Cast columns as rows, so that each value is a different row in a single column. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UpperBound` The upper boundary for a value. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UseNewDataFrame` Create a new container to hold a dataset. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` A static value that can be used in a comparison, a substitution, or in another context-specific way. A `Value` can be a number, string, or other datatype, depending on the recipe action in which it's used. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value1` A value that's used by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value2` A value that's used by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueColumn` The column that is provided as a value that's used by this operation. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ViewFrame` The subset of rows currently available for viewing. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe RecipeStep Represents a single step from a DataBrew recipe to be performed. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-databrew-recipe-recipestep-action)" : Action, "[ConditionExpressions](#cfn-databrew-recipe-recipestep-conditionexpressions)" : [ ConditionExpression, ... ] } ``` ### YAML ``` [Action](#cfn-databrew-recipe-recipestep-action): Action [ConditionExpressions](#cfn-databrew-recipe-recipestep-conditionexpressions): - ConditionExpression ``` ## Properties `Action` The particular action to be performed in the recipe step. *Required*: Yes *Type*: [Action](aws-properties-databrew-recipe-action.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConditionExpressions` One or more conditions that must be met for the recipe step to succeed. All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation. *Required*: No *Type*: Array of [ConditionExpression](aws-properties-databrew-recipe-conditionexpression.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe S3Location Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-databrew-recipe-s3location-bucket)" : String, "[Key](#cfn-databrew-recipe-s3location-key)" : String } ``` ### YAML ``` [Bucket](#cfn-databrew-recipe-s3location-bucket): String [Key](#cfn-databrew-recipe-s3location-key): String ``` ## Properties `Bucket` The Amazon S3 bucket name. *Required*: Yes *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The unique name of the object in the bucket. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1280` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe SecondaryInput Represents secondary inputs in a UNION transform. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataCatalogInputDefinition](#cfn-databrew-recipe-secondaryinput-datacataloginputdefinition)" : DataCatalogInputDefinition, "[S3InputDefinition](#cfn-databrew-recipe-secondaryinput-s3inputdefinition)" : S3Location } ``` ### YAML ``` [DataCatalogInputDefinition](#cfn-databrew-recipe-secondaryinput-datacataloginputdefinition): DataCatalogInputDefinition [S3InputDefinition](#cfn-databrew-recipe-secondaryinput-s3inputdefinition): S3Location ``` ## Properties `DataCatalogInputDefinition` The AWS Glue Data Catalog parameters for the data. *Required*: No *Type*: [DataCatalogInputDefinition](aws-properties-databrew-recipe-datacataloginputdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3InputDefinition` The Amazon S3 location where the data is stored. *Required*: No *Type*: [S3Location](aws-properties-databrew-recipe-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Recipe Tag The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Recipe](aws-resource-databrew-recipe.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-recipe-tag-key)" : String, "[Value](#cfn-databrew-recipe-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-recipe-tag-key): String [Value](#cfn-databrew-recipe-tag-value): String ``` ## Properties `Key` 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` 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) # AWS::DataBrew::Ruleset Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataBrew::Ruleset", "Properties" : { "[Description](#cfn-databrew-ruleset-description)" : String, "[Name](#cfn-databrew-ruleset-name)" : String, "[Rules](#cfn-databrew-ruleset-rules)" : [ Rule, ... ], "[Tags](#cfn-databrew-ruleset-tags)" : [ Tag, ... ], "[TargetArn](#cfn-databrew-ruleset-targetarn)" : String } } ``` ### YAML ``` Type: AWS::DataBrew::Ruleset Properties: [Description](#cfn-databrew-ruleset-description): String [Name](#cfn-databrew-ruleset-name): String [Rules](#cfn-databrew-ruleset-rules): - Rule [Tags](#cfn-databrew-ruleset-tags): - Tag [TargetArn](#cfn-databrew-ruleset-targetarn): String ``` ## Properties `Description` The description of the ruleset. *Required*: No *Type*: String *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the ruleset. *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) `Rules` Contains metadata about the ruleset. *Required*: Yes *Type*: Array of [Rule](aws-properties-databrew-ruleset-rule.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). *Required*: No *Type*: Array of [Tag](aws-properties-databrew-ruleset-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetArn` The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. *Required*: Yes *Type*: String *Minimum*: `20` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## 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": "myRuleset" }`. For an AWS Glue DataBrew ruleset named `myRuleset`, `Ref` returns the name of the ruleset. # AWS::DataBrew::Ruleset ColumnSelector Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-databrew-ruleset-columnselector-name)" : String, "[Regex](#cfn-databrew-ruleset-columnselector-regex)" : String } ``` ### YAML ``` [Name](#cfn-databrew-ruleset-columnselector-name): String [Regex](#cfn-databrew-ruleset-columnselector-regex): String ``` ## Properties `Name` The name of a column from a dataset. *Required*: No *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) `Regex` A regular expression for selecting a column from a dataset. *Required*: No *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) # AWS::DataBrew::Ruleset Rule Represents a single data quality requirement that should be validated in the scope of this dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CheckExpression](#cfn-databrew-ruleset-rule-checkexpression)" : String, "[ColumnSelectors](#cfn-databrew-ruleset-rule-columnselectors)" : [ ColumnSelector, ... ], "[Disabled](#cfn-databrew-ruleset-rule-disabled)" : Boolean, "[Name](#cfn-databrew-ruleset-rule-name)" : String, "[SubstitutionMap](#cfn-databrew-ruleset-rule-substitutionmap)" : [ SubstitutionValue, ... ], "[Threshold](#cfn-databrew-ruleset-rule-threshold)" : Threshold } ``` ### YAML ``` [CheckExpression](#cfn-databrew-ruleset-rule-checkexpression): String [ColumnSelectors](#cfn-databrew-ruleset-rule-columnselectors): - ColumnSelector [Disabled](#cfn-databrew-ruleset-rule-disabled): Boolean [Name](#cfn-databrew-ruleset-rule-name): String [SubstitutionMap](#cfn-databrew-ruleset-rule-substitutionmap): - SubstitutionValue [Threshold](#cfn-databrew-ruleset-rule-threshold): Threshold ``` ## Properties `CheckExpression` The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, `(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)`. Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, `is_between :val1 and :val2`. *Required*: Yes *Type*: String *Pattern*: `^[><0-9A-Za-z_.,:)(!= ]+$` *Minimum*: `4` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnSelectors` List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns. *Required*: No *Type*: Array of [ColumnSelector](aws-properties-databrew-ruleset-columnselector.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Disabled` A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the rule. *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) `SubstitutionMap` The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, `":col1": "`Column A`".` *Required*: No *Type*: Array of [SubstitutionValue](aws-properties-databrew-ruleset-substitutionvalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Threshold` The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds. *Required*: No *Type*: [Threshold](aws-properties-databrew-ruleset-threshold.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Ruleset SubstitutionValue A key-value pair to associate an expression's substitution variable names with their values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Value](#cfn-databrew-ruleset-substitutionvalue-value)" : String, "[ValueReference](#cfn-databrew-ruleset-substitutionvalue-valuereference)" : String } ``` ### YAML ``` [Value](#cfn-databrew-ruleset-substitutionvalue-value): String [ValueReference](#cfn-databrew-ruleset-substitutionvalue-valuereference): String ``` ## Properties `Value` Value or column name. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueReference` Variable name. *Required*: Yes *Type*: String *Pattern*: `^:[A-Za-z0-9_]+$` *Minimum*: `2` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Ruleset Tag The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Ruleset](aws-resource-databrew-ruleset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-ruleset-tag-key)" : String, "[Value](#cfn-databrew-ruleset-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-ruleset-tag-key): String [Value](#cfn-databrew-ruleset-tag-value): String ``` ## Properties `Key` 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` 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) # AWS::DataBrew::Ruleset Threshold The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-databrew-ruleset-threshold-type)" : String, "[Unit](#cfn-databrew-ruleset-threshold-unit)" : String, "[Value](#cfn-databrew-ruleset-threshold-value)" : Number } ``` ### YAML ``` [Type](#cfn-databrew-ruleset-threshold-type): String [Unit](#cfn-databrew-ruleset-threshold-unit): String [Value](#cfn-databrew-ruleset-threshold-value): Number ``` ## Properties `Type` The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value. *Required*: No *Type*: String *Allowed values*: `GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | GREATER_THAN | LESS_THAN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Unit` Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation. *Required*: No *Type*: String *Allowed values*: `COUNT | PERCENTAGE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of a threshold. *Required*: Yes *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataBrew::Schedule Specifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataBrew::Schedule", "Properties" : { "[CronExpression](#cfn-databrew-schedule-cronexpression)" : String, "[JobNames](#cfn-databrew-schedule-jobnames)" : [ String, ... ], "[Name](#cfn-databrew-schedule-name)" : String, "[Tags](#cfn-databrew-schedule-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataBrew::Schedule Properties: [CronExpression](#cfn-databrew-schedule-cronexpression): String [JobNames](#cfn-databrew-schedule-jobnames): - String [Name](#cfn-databrew-schedule-name): String [Tags](#cfn-databrew-schedule-tags): - Tag ``` ## Properties `CronExpression` The dates and times when the job is to run. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer Guide*. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JobNames` A list of jobs to be run, according to the schedule. *Required*: No *Type*: Array of String *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the schedule. *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) `Tags` Metadata tags that have been applied to the schedule. *Required*: No *Type*: Array of [Tag](aws-properties-databrew-schedule-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 ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{ "Ref": "mySchedule" }` For an AWS Glue DataBrew schedule named `mySchedule`, `Ref` returns the name of the schedule. ## Examples ### Creating schedules The following examples create new DataBrew schedules. #### YAML ``` Resources: TestDataBrewSchedule: Type: AWS::DataBrew::Schedule Properties: JobNames: ["job-name"] Name: schedule-name CronExpression: "cron(0 0/1 ? * * *)" Tags: [{Key: key00AtCreate, Value: value001AtCreate}] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "This CloudFormation template specifies a DataBrew Schedule", "Resources": { "MyDataBrewSchedule": { "Type": "AWS::DataBrew::Schedule", "Properties": { "JobNames": ["job-test"], "Name": "cf-test-schedule1", "CronExpression": "cron(0 0/1 ? * * *)" }, "Tags": [ { "Key": "key00AtCreate", "Value": "value001AtCreate" } ] } } } ``` # AWS::DataBrew::Schedule Tag The `Tag` property type specifies Property description not available. for an [AWS::DataBrew::Schedule](aws-resource-databrew-schedule.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-databrew-schedule-tag-key)" : String, "[Value](#cfn-databrew-schedule-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-databrew-schedule-tag-key): String [Value](#cfn-databrew-schedule-tag-value): String ``` ## Properties `Key` 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` 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)