aws-cdk-lib.aws_databrew.CfnRecipe.RecipeParametersProperty

interface RecipeParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.DataBrew.CfnRecipe.RecipeParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdatabrew#CfnRecipe_RecipeParametersProperty
Javasoftware.amazon.awscdk.services.databrew.CfnRecipe.RecipeParametersProperty
Pythonaws_cdk.aws_databrew.CfnRecipe.RecipeParametersProperty
TypeScript aws-cdk-lib » aws_databrew » CfnRecipe » RecipeParametersProperty

Parameters that are used as inputs for various recipe actions.

The parameters are specific to the context in which they're used.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_databrew as databrew } from 'aws-cdk-lib';

declare const input: any;
const recipeParametersProperty: databrew.CfnRecipe.RecipeParametersProperty = {
  aggregateFunction: 'aggregateFunction',
  base: 'base',
  caseStatement: 'caseStatement',
  categoryMap: 'categoryMap',
  charsToRemove: 'charsToRemove',
  collapseConsecutiveWhitespace: 'collapseConsecutiveWhitespace',
  columnDataType: 'columnDataType',
  columnRange: 'columnRange',
  count: 'count',
  customCharacters: 'customCharacters',
  customStopWords: 'customStopWords',
  customValue: 'customValue',
  datasetsColumns: 'datasetsColumns',
  dateAddValue: 'dateAddValue',
  dateTimeFormat: 'dateTimeFormat',
  dateTimeParameters: 'dateTimeParameters',
  deleteOtherRows: 'deleteOtherRows',
  delimiter: 'delimiter',
  endPattern: 'endPattern',
  endPosition: 'endPosition',
  endValue: 'endValue',
  expandContractions: 'expandContractions',
  exponent: 'exponent',
  falseString: 'falseString',
  groupByAggFunctionOptions: 'groupByAggFunctionOptions',
  groupByColumns: 'groupByColumns',
  hiddenColumns: 'hiddenColumns',
  ignoreCase: 'ignoreCase',
  includeInSplit: 'includeInSplit',
  input: input,
  interval: 'interval',
  isText: 'isText',
  joinKeys: 'joinKeys',
  joinType: 'joinType',
  leftColumns: 'leftColumns',
  limit: 'limit',
  lowerBound: 'lowerBound',
  mapType: 'mapType',
  modeType: 'modeType',
  multiLine: false,
  numRows: 'numRows',
  numRowsAfter: 'numRowsAfter',
  numRowsBefore: 'numRowsBefore',
  orderByColumn: 'orderByColumn',
  orderByColumns: 'orderByColumns',
  other: 'other',
  pattern: 'pattern',
  patternOption1: 'patternOption1',
  patternOption2: 'patternOption2',
  patternOptions: 'patternOptions',
  period: 'period',
  position: 'position',
  removeAllPunctuation: 'removeAllPunctuation',
  removeAllQuotes: 'removeAllQuotes',
  removeAllWhitespace: 'removeAllWhitespace',
  removeCustomCharacters: 'removeCustomCharacters',
  removeCustomValue: 'removeCustomValue',
  removeLeadingAndTrailingPunctuation: 'removeLeadingAndTrailingPunctuation',
  removeLeadingAndTrailingQuotes: 'removeLeadingAndTrailingQuotes',
  removeLeadingAndTrailingWhitespace: 'removeLeadingAndTrailingWhitespace',
  removeLetters: 'removeLetters',
  removeNumbers: 'removeNumbers',
  removeSourceColumn: 'removeSourceColumn',
  removeSpecialCharacters: 'removeSpecialCharacters',
  rightColumns: 'rightColumns',
  sampleSize: 'sampleSize',
  sampleType: 'sampleType',
  secondaryInputs: [{
    dataCatalogInputDefinition: {
      catalogId: 'catalogId',
      databaseName: 'databaseName',
      tableName: 'tableName',
      tempDirectory: {
        bucket: 'bucket',

        // the properties below are optional
        key: 'key',
      },
    },
    s3InputDefinition: {
      bucket: 'bucket',

      // the properties below are optional
      key: 'key',
    },
  }],
  secondInput: 'secondInput',
  sheetIndexes: [123],
  sheetNames: ['sheetNames'],
  sourceColumn: 'sourceColumn',
  sourceColumn1: 'sourceColumn1',
  sourceColumn2: 'sourceColumn2',
  sourceColumns: 'sourceColumns',
  startColumnIndex: 'startColumnIndex',
  startPattern: 'startPattern',
  startPosition: 'startPosition',
  startValue: 'startValue',
  stemmingMode: 'stemmingMode',
  stepCount: 'stepCount',
  stepIndex: 'stepIndex',
  stopWordsMode: 'stopWordsMode',
  strategy: 'strategy',
  targetColumn: 'targetColumn',
  targetColumnNames: 'targetColumnNames',
  targetDateFormat: 'targetDateFormat',
  targetIndex: 'targetIndex',
  timeZone: 'timeZone',
  tokenizerPattern: 'tokenizerPattern',
  trueString: 'trueString',
  udfLang: 'udfLang',
  units: 'units',
  unpivotColumn: 'unpivotColumn',
  upperBound: 'upperBound',
  useNewDataFrame: 'useNewDataFrame',
  value: 'value',
  value1: 'value1',
  value2: 'value2',
  valueColumn: 'valueColumn',
  viewFrame: 'viewFrame',
};

Properties

NameTypeDescription
aggregateFunction?stringThe name of an aggregation function to apply.
base?stringThe number of digits used in a counting system.
caseStatement?stringA case statement associated with a recipe.
categoryMap?stringA category map used for one-hot encoding.
charsToRemove?stringCharacters to remove from a step that applies one-hot encoding or tokenization.
collapseConsecutiveWhitespace?stringRemove any non-word non-punctuation character.
columnDataType?stringThe data type of the column.
columnRange?stringA range of columns to which a step is applied.
count?stringThe number of times a string needs to be repeated.
customCharacters?stringOne or more characters that can be substituted or removed, depending on the context.
customStopWords?stringA list of words to ignore in a step that applies word tokenization.
customValue?stringA list of custom values to use in a step that requires that you provide a value to finish the operation.
datasetsColumns?stringA list of the dataset columns included in a project.
dateAddValue?stringA value that specifies how many units of time to add or subtract for a date math operation.
dateTimeFormat?stringA date format to apply to a date.
dateTimeParameters?stringA set of parameters associated with a datetime.
deleteOtherRows?stringDetermines whether unmapped rows in a categorical mapping should be deleted.
delimiter?stringThe delimiter to use when parsing separated values in a text file.
endPattern?stringThe end pattern to locate.
endPosition?stringThe end position to locate.
endValue?stringThe end value to locate.
expandContractions?stringA list of word contractions and what they expand to.
exponent?stringThe exponent to apply in an exponential operation.
falseString?stringA value that represents FALSE .
groupByAggFunctionOptions?stringSpecifies options to apply to the GROUP BY used in an aggregation.
groupByColumns?stringThe columns to use in the GROUP BY clause.
hiddenColumns?stringA list of columns to hide.
ignoreCase?stringIndicates that lower and upper case letters are treated equally.
includeInSplit?stringIndicates if this column is participating in a split transform.
input?anyThe input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
interval?stringThe number of characters to split by.
isText?stringIndicates if the content is text.
joinKeys?stringThe keys or columns involved in a join.
joinType?stringThe type of join to use, for example, INNER JOIN , OUTER JOIN , and so on.
leftColumns?stringThe columns on the left side of the join.
limit?stringThe number of times to perform split or replaceBy in a string.
lowerBound?stringThe lower boundary for a value.
mapType?stringThe type of mappings to apply to construct a new dynamic frame.
modeType?stringDetermines the manner in which mode value is calculated, in case there is more than one mode value.
multiLine?boolean | IResolvableSpecifies whether JSON input contains embedded new line characters.
numRows?stringThe number of rows to consider in a window.
numRowsAfter?stringThe number of rows to consider after the current row in a window.
numRowsBefore?stringThe number of rows to consider before the current row in a window.
orderByColumn?stringA column to sort the results by.
orderByColumns?stringThe columns to sort the results by.
other?stringThe value to assign to unmapped cells, in categorical mapping.
pattern?stringThe pattern to locate.
patternOption1?stringThe starting pattern to split between.
patternOption2?stringThe ending pattern to split between.
patternOptions?stringFor splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.
period?stringThe size of the rolling window.
position?stringThe character index within a string.
removeAllPunctuation?stringIf true , removes all of the following characters: . .! ., .?.
removeAllQuotes?stringIf true , removes all single quotes and double quotes.
removeAllWhitespace?stringIf true , removes all whitespaces from the value.
removeCustomCharacters?stringIf true , removes all chraracters specified by CustomCharacters .
removeCustomValue?stringIf true , removes all chraracters specified by CustomValue .
removeLeadingAndTrailingPunctuation?stringIf true , removes the following characters if they occur at the start or end of the value: . ! , ?.
removeLeadingAndTrailingQuotes?stringIf true , removes single quotes and double quotes from the beginning and end of the value.
removeLeadingAndTrailingWhitespace?stringIf true , removes all whitespaces from the beginning and end of the value.
removeLetters?stringIf true , removes all uppercase and lowercase alphabetic characters (A through Z;
removeNumbers?stringIf true , removes all numeric characters (0 through 9).
removeSourceColumn?stringIf true , the source column will be removed after un-nesting that column.
removeSpecialCharacters?stringIf true , removes all of the following characters: `!
rightColumns?stringThe columns on the right side of a join.
sampleSize?stringThe number of rows in the sample.
sampleType?stringThe sampling type to apply to the dataset.
secondInput?stringA object value to indicate the second dataset used in a join.
secondaryInputs?IResolvable | IResolvable | SecondaryInputProperty[]A list of secondary inputs in a UNION transform.
sheetIndexes?number[] | IResolvableOne or more sheet numbers in the Excel file, which will be included in a dataset.
sheetNames?string[]Oone or more named sheets in the Excel file, which will be included in a dataset.
sourceColumn?stringA source column needed for an operation, step, or transform.
sourceColumn1?stringA source column needed for an operation, step, or transform.
sourceColumn2?stringA source column needed for an operation, step, or transform.
sourceColumns?stringA list of source columns needed for an operation, step, or transform.
startColumnIndex?stringThe index number of the first column used by an operation, step, or transform.
startPattern?stringThe starting pattern to locate.
startPosition?stringThe starting position to locate.
startValue?stringThe starting value to locate.
stemmingMode?stringIndicates this operation uses stems and lemmas (base words) for word tokenization.
stepCount?stringThe total number of transforms in this recipe.
stepIndex?stringThe index ID of a step.
stopWordsMode?stringIndicates this operation uses stop words as part of word tokenization.
strategy?stringThe resolution strategy to apply in resolving ambiguities.
targetColumn?stringThe column targeted by this operation.
targetColumnNames?stringThe names to give columns altered by this operation.
targetDateFormat?stringThe date format to convert to.
targetIndex?stringThe index number of an object that is targeted by this operation.
timeZone?stringThe current timezone that you want to use for dates.
tokenizerPattern?stringA regex expression to use when splitting text into terms, also called words or tokens.
trueString?stringA value to use to represent TRUE .
udfLang?stringThe language that's used in the user-defined function.
units?stringSpecifies a unit of time.
unpivotColumn?stringCast columns as rows, so that each value is a different row in a single column.
upperBound?stringThe upper boundary for a value.
useNewDataFrame?stringCreate a new container to hold a dataset.
value?stringA static value that can be used in a comparison, a substitution, or in another context-specific way.
value1?stringA value that's used by this operation.
value2?stringA value that's used by this operation.
valueColumn?stringThe column that is provided as a value that's used by this operation.
viewFrame?stringThe subset of rows currently available for viewing.

aggregateFunction?

Type: string (optional)

The name of an aggregation function to apply.


base?

Type: string (optional)

The number of digits used in a counting system.


caseStatement?

Type: string (optional)

A case statement associated with a recipe.


categoryMap?

Type: string (optional)

A category map used for one-hot encoding.


charsToRemove?

Type: string (optional)

Characters to remove from a step that applies one-hot encoding or tokenization.


collapseConsecutiveWhitespace?

Type: string (optional)

Remove any non-word non-punctuation character.


columnDataType?

Type: string (optional)

The data type of the column.


columnRange?

Type: string (optional)

A range of columns to which a step is applied.


count?

Type: string (optional)

The number of times a string needs to be repeated.


customCharacters?

Type: string (optional)

One or more characters that can be substituted or removed, depending on the context.


customStopWords?

Type: string (optional)

A list of words to ignore in a step that applies word tokenization.


customValue?

Type: string (optional)

A list of custom values to use in a step that requires that you provide a value to finish the operation.


datasetsColumns?

Type: string (optional)

A list of the dataset columns included in a project.


dateAddValue?

Type: string (optional)

A value that specifies how many units of time to add or subtract for a date math operation.


dateTimeFormat?

Type: string (optional)

A date format to apply to a date.


dateTimeParameters?

Type: string (optional)

A set of parameters associated with a datetime.


deleteOtherRows?

Type: string (optional)

Determines whether unmapped rows in a categorical mapping should be deleted.


delimiter?

Type: string (optional)

The delimiter to use when parsing separated values in a text file.


endPattern?

Type: string (optional)

The end pattern to locate.


endPosition?

Type: string (optional)

The end position to locate.


endValue?

Type: string (optional)

The end value to locate.


expandContractions?

Type: string (optional)

A list of word contractions and what they expand to.

For eample: can't ; cannot ; can not .


exponent?

Type: string (optional)

The exponent to apply in an exponential operation.


falseString?

Type: string (optional)

A value that represents FALSE .


groupByAggFunctionOptions?

Type: string (optional)

Specifies options to apply to the GROUP BY used in an aggregation.


groupByColumns?

Type: string (optional)

The columns to use in the GROUP BY clause.


hiddenColumns?

Type: string (optional)

A list of columns to hide.


ignoreCase?

Type: string (optional)

Indicates that lower and upper case letters are treated equally.


includeInSplit?

Type: string (optional)

Indicates if this column is participating in a split transform.


input?

Type: any (optional)

The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .


interval?

Type: string (optional)

The number of characters to split by.


isText?

Type: string (optional)

Indicates if the content is text.


joinKeys?

Type: string (optional)

The keys or columns involved in a join.


joinType?

Type: string (optional)

The type of join to use, for example, INNER JOIN , OUTER JOIN , and so on.


leftColumns?

Type: string (optional)

The columns on the left side of the join.


limit?

Type: string (optional)

The number of times to perform split or replaceBy in a string.


lowerBound?

Type: string (optional)

The lower boundary for a value.


mapType?

Type: string (optional)

The type of mappings to apply to construct a new dynamic frame.


modeType?

Type: string (optional)

Determines the manner in which mode value is calculated, in case there is more than one mode value.

Valid values: NONE | AVERAGE | MINIMUM | MAXIMUM


multiLine?

Type: boolean | IResolvable (optional)

Specifies whether JSON input contains embedded new line characters.


numRows?

Type: string (optional)

The number of rows to consider in a window.


numRowsAfter?

Type: string (optional)

The number of rows to consider after the current row in a window.


numRowsBefore?

Type: string (optional)

The number of rows to consider before the current row in a window.


orderByColumn?

Type: string (optional)

A column to sort the results by.


orderByColumns?

Type: string (optional)

The columns to sort the results by.


other?

Type: string (optional)

The value to assign to unmapped cells, in categorical mapping.


pattern?

Type: string (optional)

The pattern to locate.


patternOption1?

Type: string (optional)

The starting pattern to split between.


patternOption2?

Type: string (optional)

The ending pattern to split between.


patternOptions?

Type: string (optional)

For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.

For example: [{\"pattern\":\"1\",\"includeInSplit\":true}]


period?

Type: string (optional)

The size of the rolling window.


position?

Type: string (optional)

The character index within a string.


removeAllPunctuation?

Type: string (optional)

If true , removes all of the following characters: . .! ., .?.


removeAllQuotes?

Type: string (optional)

If true , removes all single quotes and double quotes.


removeAllWhitespace?

Type: string (optional)

If true , removes all whitespaces from the value.


removeCustomCharacters?

Type: string (optional)

If true , removes all chraracters specified by CustomCharacters .


removeCustomValue?

Type: string (optional)

If true , removes all chraracters specified by CustomValue .


removeLeadingAndTrailingPunctuation?

Type: string (optional)

If true , removes the following characters if they occur at the start or end of the value: . ! , ?.


removeLeadingAndTrailingQuotes?

Type: string (optional)

If true , removes single quotes and double quotes from the beginning and end of the value.


removeLeadingAndTrailingWhitespace?

Type: string (optional)

If true , removes all whitespaces from the beginning and end of the value.


removeLetters?

Type: string (optional)

If true , removes all uppercase and lowercase alphabetic characters (A through Z;

a through z).


removeNumbers?

Type: string (optional)

If true , removes all numeric characters (0 through 9).


removeSourceColumn?

Type: string (optional)

If true , the source column will be removed after un-nesting that column.

(Used with nested column types, such as Map, Struct, or Array.)


removeSpecialCharacters?

Type: string (optional)

If true , removes all of the following characters: `!

" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~


rightColumns?

Type: string (optional)

The columns on the right side of a join.


sampleSize?

Type: string (optional)

The number of rows in the sample.


sampleType?

Type: string (optional)

The sampling type to apply to the dataset.

Valid values: FIRST_N | LAST_N | RANDOM


secondInput?

Type: string (optional)

A object value to indicate the second dataset used in a join.


secondaryInputs?

Type: IResolvable | IResolvable | SecondaryInputProperty[] (optional)

A list of secondary inputs in a UNION transform.


sheetIndexes?

Type: number[] | IResolvable (optional)

One or more sheet numbers in the Excel file, which will be included in a dataset.


sheetNames?

Type: string[] (optional)

Oone or more named sheets in the Excel file, which will be included in a dataset.


sourceColumn?

Type: string (optional)

A source column needed for an operation, step, or transform.


sourceColumn1?

Type: string (optional)

A source column needed for an operation, step, or transform.


sourceColumn2?

Type: string (optional)

A source column needed for an operation, step, or transform.


sourceColumns?

Type: string (optional)

A list of source columns needed for an operation, step, or transform.


startColumnIndex?

Type: string (optional)

The index number of the first column used by an operation, step, or transform.


startPattern?

Type: string (optional)

The starting pattern to locate.


startPosition?

Type: string (optional)

The starting position to locate.


startValue?

Type: string (optional)

The starting value to locate.


stemmingMode?

Type: string (optional)

Indicates this operation uses stems and lemmas (base words) for word tokenization.


stepCount?

Type: string (optional)

The total number of transforms in this recipe.


stepIndex?

Type: string (optional)

The index ID of a step.


stopWordsMode?

Type: string (optional)

Indicates this operation uses stop words as part of word tokenization.


strategy?

Type: string (optional)

The resolution strategy to apply in resolving ambiguities.


targetColumn?

Type: string (optional)

The column targeted by this operation.


targetColumnNames?

Type: string (optional)

The names to give columns altered by this operation.


targetDateFormat?

Type: string (optional)

The date format to convert to.


targetIndex?

Type: string (optional)

The index number of an object that is targeted by this operation.


timeZone?

Type: string (optional)

The current timezone that you want to use for dates.


tokenizerPattern?

Type: string (optional)

A regex expression to use when splitting text into terms, also called words or tokens.


trueString?

Type: string (optional)

A value to use to represent TRUE .


udfLang?

Type: string (optional)

The language that's used in the user-defined function.


units?

Type: string (optional)

Specifies a unit of time.

For example: MINUTES ; SECONDS ; HOURS ; etc.


unpivotColumn?

Type: string (optional)

Cast columns as rows, so that each value is a different row in a single column.


upperBound?

Type: string (optional)

The upper boundary for a value.


useNewDataFrame?

Type: string (optional)

Create a new container to hold a dataset.


value?

Type: string (optional)

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.


value1?

Type: string (optional)

A value that's used by this operation.


value2?

Type: string (optional)

A value that's used by this operation.


valueColumn?

Type: string (optional)

The column that is provided as a value that's used by this operation.


viewFrame?

Type: string (optional)

The subset of rows currently available for viewing.