CfnRecipe.RecipeParametersProperty (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnRecipe.RecipeParametersProperty.Jsii$Proxy

Enclosing class:: CfnRecipe

@Stability(value=Stable)
public static interface CfnRecipe.RecipeParametersProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.databrew.*;
 Object input;
 RecipeParametersProperty recipeParametersProperty = RecipeParametersProperty.builder()
         .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(List.of(SecondaryInputProperty.builder()
                 .dataCatalogInputDefinition(DataCatalogInputDefinitionProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .tableName("tableName")
                         .tempDirectory(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .key("key")
                                 .build())
                         .build())
                 .s3InputDefinition(S3LocationProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .key("key")
                         .build())
                 .build()))
         .secondInput("secondInput")
         .sheetIndexes(List.of(123))
         .sheetNames(List.of("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")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnRecipe.RecipeParametersProperty.Builder` A builder for `CfnRecipe.RecipeParametersProperty`
`static class`	`CfnRecipe.RecipeParametersProperty.Jsii$Proxy` An implementation for `CfnRecipe.RecipeParametersProperty`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnRecipe.RecipeParametersProperty.Builder`	`builder()`
`default String`	`getAggregateFunction()` The name of an aggregation function to apply.
`default String`	`getBase()` The number of digits used in a counting system.
`default String`	`getCaseStatement()` A case statement associated with a recipe.
`default String`	`getCategoryMap()` A category map used for one-hot encoding.
`default String`	`getCharsToRemove()` Characters to remove from a step that applies one-hot encoding or tokenization.
`default String`	`getCollapseConsecutiveWhitespace()` Remove any non-word non-punctuation character.
`default String`	`getColumnDataType()` The data type of the column.
`default String`	`getColumnRange()` A range of columns to which a step is applied.
`default String`	`getCount()` The number of times a string needs to be repeated.
`default String`	`getCustomCharacters()` One or more characters that can be substituted or removed, depending on the context.
`default String`	`getCustomStopWords()` A list of words to ignore in a step that applies word tokenization.
`default String`	`getCustomValue()` A list of custom values to use in a step that requires that you provide a value to finish the operation.
`default String`	`getDatasetsColumns()` A list of the dataset columns included in a project.
`default String`	`getDateAddValue()` A value that specifies how many units of time to add or subtract for a date math operation.
`default String`	`getDateTimeFormat()` A date format to apply to a date.
`default String`	`getDateTimeParameters()` A set of parameters associated with a datetime.
`default String`	`getDeleteOtherRows()` Determines whether unmapped rows in a categorical mapping should be deleted.
`default String`	`getDelimiter()` The delimiter to use when parsing separated values in a text file.
`default String`	`getEndPattern()` The end pattern to locate.
`default String`	`getEndPosition()` The end position to locate.
`default String`	`getEndValue()` The end value to locate.
`default String`	`getExpandContractions()` A list of word contractions and what they expand to.
`default String`	`getExponent()` The exponent to apply in an exponential operation.
`default String`	`getFalseString()` A value that represents `FALSE` .
`default String`	`getGroupByAggFunctionOptions()` Specifies options to apply to the `GROUP BY` used in an aggregation.
`default String`	`getGroupByColumns()` The columns to use in the `GROUP BY` clause.
`default String`	`getHiddenColumns()` A list of columns to hide.
`default String`	`getIgnoreCase()` Indicates that lower and upper case letters are treated equally.
`default String`	`getIncludeInSplit()` Indicates if this column is participating in a split transform.
`default Object`	`getInput()` The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
`default String`	`getInterval()` The number of characters to split by.
`default String`	`getIsText()` Indicates if the content is text.
`default String`	`getJoinKeys()` The keys or columns involved in a join.
`default String`	`getJoinType()` The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on.
`default String`	`getLeftColumns()` The columns on the left side of the join.
`default String`	`getLimit()` The number of times to perform `split` or `replaceBy` in a string.
`default String`	`getLowerBound()` The lower boundary for a value.
`default String`	`getMapType()` The type of mappings to apply to construct a new dynamic frame.
`default String`	`getModeType()` Determines the manner in which mode value is calculated, in case there is more than one mode value.
`default Object`	`getMultiLine()` Specifies whether JSON input contains embedded new line characters.
`default String`	`getNumRows()` The number of rows to consider in a window.
`default String`	`getNumRowsAfter()` The number of rows to consider after the current row in a window.
`default String`	`getNumRowsBefore()` The number of rows to consider before the current row in a window.
`default String`	`getOrderByColumn()` A column to sort the results by.
`default String`	`getOrderByColumns()` The columns to sort the results by.
`default String`	`getOther()` The value to assign to unmapped cells, in categorical mapping.
`default String`	`getPattern()` The pattern to locate.
`default String`	`getPatternOption1()` The starting pattern to split between.
`default String`	`getPatternOption2()` The ending pattern to split between.
`default String`	`getPatternOptions()` For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.
`default String`	`getPeriod()` The size of the rolling window.
`default String`	`getPosition()` The character index within a string.
`default String`	`getRemoveAllPunctuation()` If `true` , removes all of the following characters: `.` `.!` `.,` `.?`.
`default String`	`getRemoveAllQuotes()` If `true` , removes all single quotes and double quotes.
`default String`	`getRemoveAllWhitespace()` If `true` , removes all whitespaces from the value.
`default String`	`getRemoveCustomCharacters()` If `true` , removes all chraracters specified by `CustomCharacters` .
`default String`	`getRemoveCustomValue()` If `true` , removes all chraracters specified by `CustomValue` .
`default String`	`getRemoveLeadingAndTrailingPunctuation()` If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`.
`default String`	`getRemoveLeadingAndTrailingQuotes()` If `true` , removes single quotes and double quotes from the beginning and end of the value.
`default String`	`getRemoveLeadingAndTrailingWhitespace()` If `true` , removes all whitespaces from the beginning and end of the value.
`default String`	`getRemoveLetters()` If `true` , removes all uppercase and lowercase alphabetic characters (A through Z;
`default String`	`getRemoveNumbers()` If `true` , removes all numeric characters (0 through 9).
`default String`	`getRemoveSourceColumn()` If `true` , the source column will be removed after un-nesting that column.
`default String`	`getRemoveSpecialCharacters()` If `true` , removes all of the following characters: `!
`default String`	`getRightColumns()` The columns on the right side of a join.
`default String`	`getSampleSize()` The number of rows in the sample.
`default String`	`getSampleType()` The sampling type to apply to the dataset.
`default Object`	`getSecondaryInputs()` A list of secondary inputs in a UNION transform.
`default String`	`getSecondInput()` A object value to indicate the second dataset used in a join.
`default Object`	`getSheetIndexes()` One or more sheet numbers in the Excel file, which will be included in a dataset.
`default List<String>`	`getSheetNames()` Oone or more named sheets in the Excel file, which will be included in a dataset.
`default String`	`getSourceColumn()` A source column needed for an operation, step, or transform.
`default String`	`getSourceColumn1()` A source column needed for an operation, step, or transform.
`default String`	`getSourceColumn2()` A source column needed for an operation, step, or transform.
`default String`	`getSourceColumns()` A list of source columns needed for an operation, step, or transform.
`default String`	`getStartColumnIndex()` The index number of the first column used by an operation, step, or transform.
`default String`	`getStartPattern()` The starting pattern to locate.
`default String`	`getStartPosition()` The starting position to locate.
`default String`	`getStartValue()` The starting value to locate.
`default String`	`getStemmingMode()` Indicates this operation uses stems and lemmas (base words) for word tokenization.
`default String`	`getStepCount()` The total number of transforms in this recipe.
`default String`	`getStepIndex()` The index ID of a step.
`default String`	`getStopWordsMode()` Indicates this operation uses stop words as part of word tokenization.
`default String`	`getStrategy()` The resolution strategy to apply in resolving ambiguities.
`default String`	`getTargetColumn()` The column targeted by this operation.
`default String`	`getTargetColumnNames()` The names to give columns altered by this operation.
`default String`	`getTargetDateFormat()` The date format to convert to.
`default String`	`getTargetIndex()` The index number of an object that is targeted by this operation.
`default String`	`getTimeZone()` The current timezone that you want to use for dates.
`default String`	`getTokenizerPattern()` A regex expression to use when splitting text into terms, also called words or tokens.
`default String`	`getTrueString()` A value to use to represent `TRUE` .
`default String`	`getUdfLang()` The language that's used in the user-defined function.
`default String`	`getUnits()` Specifies a unit of time.
`default String`	`getUnpivotColumn()` Cast columns as rows, so that each value is a different row in a single column.
`default String`	`getUpperBound()` The upper boundary for a value.
`default String`	`getUseNewDataFrame()` Create a new container to hold a dataset.
`default String`	`getValue()` A static value that can be used in a comparison, a substitution, or in another context-specific way.
`default String`	`getValue1()` A value that's used by this operation.
`default String`	`getValue2()` A value that's used by this operation.
`default String`	`getValueColumn()` The column that is provided as a value that's used by this operation.
`default String`	`getViewFrame()` The subset of rows currently available for viewing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getAggregateFunction
```
@Stability(value=Stable)
 @Nullable
default String getAggregateFunction()
```
    The name of an aggregation function to apply.
  - getBase
```
@Stability(value=Stable)
 @Nullable
default String getBase()
```
    The number of digits used in a counting system.
  - getCaseStatement
```
@Stability(value=Stable)
 @Nullable
default String getCaseStatement()
```
    A case statement associated with a recipe.
  - getCategoryMap
```
@Stability(value=Stable)
 @Nullable
default String getCategoryMap()
```
    A category map used for one-hot encoding.
  - getCharsToRemove
```
@Stability(value=Stable)
 @Nullable
default String getCharsToRemove()
```
    Characters to remove from a step that applies one-hot encoding or tokenization.
  - getCollapseConsecutiveWhitespace
```
@Stability(value=Stable)
 @Nullable
default String getCollapseConsecutiveWhitespace()
```
    Remove any non-word non-punctuation character.
  - getColumnDataType
```
@Stability(value=Stable)
 @Nullable
default String getColumnDataType()
```
    The data type of the column.
  - getColumnRange
```
@Stability(value=Stable)
 @Nullable
default String getColumnRange()
```
    A range of columns to which a step is applied.
  - getCount
```
@Stability(value=Stable)
 @Nullable
default String getCount()
```
    The number of times a string needs to be repeated.
  - getCustomCharacters
```
@Stability(value=Stable)
 @Nullable
default String getCustomCharacters()
```
    One or more characters that can be substituted or removed, depending on the context.
  - getCustomStopWords
```
@Stability(value=Stable)
 @Nullable
default String getCustomStopWords()
```
    A list of words to ignore in a step that applies word tokenization.
  - getCustomValue
```
@Stability(value=Stable)
 @Nullable
default String getCustomValue()
```
    A list of custom values to use in a step that requires that you provide a value to finish the operation.
  - getDatasetsColumns
```
@Stability(value=Stable)
 @Nullable
default String getDatasetsColumns()
```
    A list of the dataset columns included in a project.
  - getDateAddValue
```
@Stability(value=Stable)
 @Nullable
default String getDateAddValue()
```
    A value that specifies how many units of time to add or subtract for a date math operation.
  - getDateTimeFormat
```
@Stability(value=Stable)
 @Nullable
default String getDateTimeFormat()
```
    A date format to apply to a date.
  - getDateTimeParameters
```
@Stability(value=Stable)
 @Nullable
default String getDateTimeParameters()
```
    A set of parameters associated with a datetime.
  - getDeleteOtherRows
```
@Stability(value=Stable)
 @Nullable
default String getDeleteOtherRows()
```
    Determines whether unmapped rows in a categorical mapping should be deleted.
  - getDelimiter
```
@Stability(value=Stable)
 @Nullable
default String getDelimiter()
```
    The delimiter to use when parsing separated values in a text file.
  - getEndPattern
```
@Stability(value=Stable)
 @Nullable
default String getEndPattern()
```
    The end pattern to locate.
  - getEndPosition
```
@Stability(value=Stable)
 @Nullable
default String getEndPosition()
```
    The end position to locate.
  - getEndValue
```
@Stability(value=Stable)
 @Nullable
default String getEndValue()
```
    The end value to locate.
  - getExpandContractions
```
@Stability(value=Stable)
 @Nullable
default String getExpandContractions()
```
    A list of word contractions and what they expand to.
    For eample: can't ; cannot ; can not .
  - getExponent
```
@Stability(value=Stable)
 @Nullable
default String getExponent()
```
    The exponent to apply in an exponential operation.
  - getFalseString
```
@Stability(value=Stable)
 @Nullable
default String getFalseString()
```
    A value that represents `FALSE` .
  - getGroupByAggFunctionOptions
```
@Stability(value=Stable)
 @Nullable
default String getGroupByAggFunctionOptions()
```
    Specifies options to apply to the `GROUP BY` used in an aggregation.
  - getGroupByColumns
```
@Stability(value=Stable)
 @Nullable
default String getGroupByColumns()
```
    The columns to use in the `GROUP BY` clause.
  - getHiddenColumns
```
@Stability(value=Stable)
 @Nullable
default String getHiddenColumns()
```
    A list of columns to hide.
  - getIgnoreCase
```
@Stability(value=Stable)
 @Nullable
default String getIgnoreCase()
```
    Indicates that lower and upper case letters are treated equally.
  - getIncludeInSplit
```
@Stability(value=Stable)
 @Nullable
default String getIncludeInSplit()
```
    Indicates if this column is participating in a split transform.
  - getInput
```
@Stability(value=Stable)
 @Nullable
default Object getInput()
```
    The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
  - getInterval
```
@Stability(value=Stable)
 @Nullable
default String getInterval()
```
    The number of characters to split by.
  - getIsText
```
@Stability(value=Stable)
 @Nullable
default String getIsText()
```
    Indicates if the content is text.
  - getJoinKeys
```
@Stability(value=Stable)
 @Nullable
default String getJoinKeys()
```
    The keys or columns involved in a join.
  - getJoinType
```
@Stability(value=Stable)
 @Nullable
default String getJoinType()
```
    The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on.
  - getLeftColumns
```
@Stability(value=Stable)
 @Nullable
default String getLeftColumns()
```
    The columns on the left side of the join.
  - getLimit
```
@Stability(value=Stable)
 @Nullable
default String getLimit()
```
    The number of times to perform `split` or `replaceBy` in a string.
  - getLowerBound
```
@Stability(value=Stable)
 @Nullable
default String getLowerBound()
```
    The lower boundary for a value.
  - getMapType
```
@Stability(value=Stable)
 @Nullable
default String getMapType()
```
    The type of mappings to apply to construct a new dynamic frame.
  - getModeType
```
@Stability(value=Stable)
 @Nullable
default String getModeType()
```
    Determines the manner in which mode value is calculated, in case there is more than one mode value.
    Valid values: NONE | AVERAGE | MINIMUM | MAXIMUM
  - getMultiLine
```
@Stability(value=Stable)
 @Nullable
default Object getMultiLine()
```
    Specifies whether JSON input contains embedded new line characters.
  - getNumRows
```
@Stability(value=Stable)
 @Nullable
default String getNumRows()
```
    The number of rows to consider in a window.
  - getNumRowsAfter
```
@Stability(value=Stable)
 @Nullable
default String getNumRowsAfter()
```
    The number of rows to consider after the current row in a window.
  - getNumRowsBefore
```
@Stability(value=Stable)
 @Nullable
default String getNumRowsBefore()
```
    The number of rows to consider before the current row in a window.
  - getOrderByColumn
```
@Stability(value=Stable)
 @Nullable
default String getOrderByColumn()
```
    A column to sort the results by.
  - getOrderByColumns
```
@Stability(value=Stable)
 @Nullable
default String getOrderByColumns()
```
    The columns to sort the results by.
  - getOther
```
@Stability(value=Stable)
 @Nullable
default String getOther()
```
    The value to assign to unmapped cells, in categorical mapping.
  - getPattern
```
@Stability(value=Stable)
 @Nullable
default String getPattern()
```
    The pattern to locate.
  - getPatternOption1
```
@Stability(value=Stable)
 @Nullable
default String getPatternOption1()
```
    The starting pattern to split between.
  - getPatternOption2
```
@Stability(value=Stable)
 @Nullable
default String getPatternOption2()
```
    The ending pattern to split between.
  - getPatternOptions
```
@Stability(value=Stable)
 @Nullable
default String getPatternOptions()
```
    For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.
    For example: [{\"pattern\":\"1\",\"includeInSplit\":true}]
  - getPeriod
```
@Stability(value=Stable)
 @Nullable
default String getPeriod()
```
    The size of the rolling window.
  - getPosition
```
@Stability(value=Stable)
 @Nullable
default String getPosition()
```
    The character index within a string.
  - getRemoveAllPunctuation
```
@Stability(value=Stable)
 @Nullable
default String getRemoveAllPunctuation()
```
    If `true` , removes all of the following characters: `.` `.!` `.,` `.?`.
  - getRemoveAllQuotes
```
@Stability(value=Stable)
 @Nullable
default String getRemoveAllQuotes()
```
    If `true` , removes all single quotes and double quotes.
  - getRemoveAllWhitespace
```
@Stability(value=Stable)
 @Nullable
default String getRemoveAllWhitespace()
```
    If `true` , removes all whitespaces from the value.
  - getRemoveCustomCharacters
```
@Stability(value=Stable)
 @Nullable
default String getRemoveCustomCharacters()
```
    If `true` , removes all chraracters specified by `CustomCharacters` .
  - getRemoveCustomValue
```
@Stability(value=Stable)
 @Nullable
default String getRemoveCustomValue()
```
    If `true` , removes all chraracters specified by `CustomValue` .
  - getRemoveLeadingAndTrailingPunctuation
```
@Stability(value=Stable)
 @Nullable
default String getRemoveLeadingAndTrailingPunctuation()
```
    If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`.
  - getRemoveLeadingAndTrailingQuotes
```
@Stability(value=Stable)
 @Nullable
default String getRemoveLeadingAndTrailingQuotes()
```
    If `true` , removes single quotes and double quotes from the beginning and end of the value.
  - getRemoveLeadingAndTrailingWhitespace
```
@Stability(value=Stable)
 @Nullable
default String getRemoveLeadingAndTrailingWhitespace()
```
    If `true` , removes all whitespaces from the beginning and end of the value.
  - getRemoveLetters
```
@Stability(value=Stable)
 @Nullable
default String getRemoveLetters()
```
    If `true` , removes all uppercase and lowercase alphabetic characters (A through Z;
    a through z).
  - getRemoveNumbers
```
@Stability(value=Stable)
 @Nullable
default String getRemoveNumbers()
```
    If `true` , removes all numeric characters (0 through 9).
  - getRemoveSourceColumn
```
@Stability(value=Stable)
 @Nullable
default String getRemoveSourceColumn()
```
    If `true` , the source column will be removed after un-nesting that column.
    (Used with nested column types, such as Map, Struct, or Array.)
  - getRemoveSpecialCharacters
```
@Stability(value=Stable)
 @Nullable
default String getRemoveSpecialCharacters()
```
    If `true` , removes all of the following characters: `!
    " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~
  - getRightColumns
```
@Stability(value=Stable)
 @Nullable
default String getRightColumns()
```
    The columns on the right side of a join.
  - getSampleSize
```
@Stability(value=Stable)
 @Nullable
default String getSampleSize()
```
    The number of rows in the sample.
  - getSampleType
```
@Stability(value=Stable)
 @Nullable
default String getSampleType()
```
    The sampling type to apply to the dataset.
    Valid values: FIRST_N | LAST_N | RANDOM
  - getSecondaryInputs
```
@Stability(value=Stable)
 @Nullable
default Object getSecondaryInputs()
```
    A list of secondary inputs in a UNION transform.
  - getSecondInput
```
@Stability(value=Stable)
 @Nullable
default String getSecondInput()
```
    A object value to indicate the second dataset used in a join.
  - getSheetIndexes
```
@Stability(value=Stable)
 @Nullable
default Object getSheetIndexes()
```
    One or more sheet numbers in the Excel file, which will be included in a dataset.
  - getSheetNames
```
@Stability(value=Stable)
 @Nullable
default List<String> getSheetNames()
```
    Oone or more named sheets in the Excel file, which will be included in a dataset.
  - getSourceColumn
```
@Stability(value=Stable)
 @Nullable
default String getSourceColumn()
```
    A source column needed for an operation, step, or transform.
  - getSourceColumn1
```
@Stability(value=Stable)
 @Nullable
default String getSourceColumn1()
```
    A source column needed for an operation, step, or transform.
  - getSourceColumn2
```
@Stability(value=Stable)
 @Nullable
default String getSourceColumn2()
```
    A source column needed for an operation, step, or transform.
  - getSourceColumns
```
@Stability(value=Stable)
 @Nullable
default String getSourceColumns()
```
    A list of source columns needed for an operation, step, or transform.
  - getStartColumnIndex
```
@Stability(value=Stable)
 @Nullable
default String getStartColumnIndex()
```
    The index number of the first column used by an operation, step, or transform.
  - getStartPattern
```
@Stability(value=Stable)
 @Nullable
default String getStartPattern()
```
    The starting pattern to locate.
  - getStartPosition
```
@Stability(value=Stable)
 @Nullable
default String getStartPosition()
```
    The starting position to locate.
  - getStartValue
```
@Stability(value=Stable)
 @Nullable
default String getStartValue()
```
    The starting value to locate.
  - getStemmingMode
```
@Stability(value=Stable)
 @Nullable
default String getStemmingMode()
```
    Indicates this operation uses stems and lemmas (base words) for word tokenization.
  - getStepCount
```
@Stability(value=Stable)
 @Nullable
default String getStepCount()
```
    The total number of transforms in this recipe.
  - getStepIndex
```
@Stability(value=Stable)
 @Nullable
default String getStepIndex()
```
    The index ID of a step.
  - getStopWordsMode
```
@Stability(value=Stable)
 @Nullable
default String getStopWordsMode()
```
    Indicates this operation uses stop words as part of word tokenization.
  - getStrategy
```
@Stability(value=Stable)
 @Nullable
default String getStrategy()
```
    The resolution strategy to apply in resolving ambiguities.
  - getTargetColumn
```
@Stability(value=Stable)
 @Nullable
default String getTargetColumn()
```
    The column targeted by this operation.
  - getTargetColumnNames
```
@Stability(value=Stable)
 @Nullable
default String getTargetColumnNames()
```
    The names to give columns altered by this operation.
  - getTargetDateFormat
```
@Stability(value=Stable)
 @Nullable
default String getTargetDateFormat()
```
    The date format to convert to.
  - getTargetIndex
```
@Stability(value=Stable)
 @Nullable
default String getTargetIndex()
```
    The index number of an object that is targeted by this operation.
  - getTimeZone
```
@Stability(value=Stable)
 @Nullable
default String getTimeZone()
```
    The current timezone that you want to use for dates.
  - getTokenizerPattern
```
@Stability(value=Stable)
 @Nullable
default String getTokenizerPattern()
```
    A regex expression to use when splitting text into terms, also called words or tokens.
  - getTrueString
```
@Stability(value=Stable)
 @Nullable
default String getTrueString()
```
    A value to use to represent `TRUE` .
  - getUdfLang
```
@Stability(value=Stable)
 @Nullable
default String getUdfLang()
```
    The language that's used in the user-defined function.
  - getUnits
```
@Stability(value=Stable)
 @Nullable
default String getUnits()
```
    Specifies a unit of time.
    For example: MINUTES ; SECONDS ; HOURS ; etc.
  - getUnpivotColumn
```
@Stability(value=Stable)
 @Nullable
default String getUnpivotColumn()
```
    Cast columns as rows, so that each value is a different row in a single column.
  - getUpperBound
```
@Stability(value=Stable)
 @Nullable
default String getUpperBound()
```
    The upper boundary for a value.
  - getUseNewDataFrame
```
@Stability(value=Stable)
 @Nullable
default String getUseNewDataFrame()
```
    Create a new container to hold a dataset.
  - getValue
```
@Stability(value=Stable)
 @Nullable
default String getValue()
```
    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.
  - getValue1
```
@Stability(value=Stable)
 @Nullable
default String getValue1()
```
    A value that's used by this operation.
  - getValue2
```
@Stability(value=Stable)
 @Nullable
default String getValue2()
```
    A value that's used by this operation.
  - getValueColumn
```
@Stability(value=Stable)
 @Nullable
default String getValueColumn()
```
    The column that is provided as a value that's used by this operation.
  - getViewFrame
```
@Stability(value=Stable)
 @Nullable
default String getViewFrame()
```
    The subset of rows currently available for viewing.
  - builder
```
@Stability(value=Stable)
static CfnRecipe.RecipeParametersProperty.Builder builder()
```
    Returns:
    
    a CfnRecipe.RecipeParametersProperty.Builder of CfnRecipe.RecipeParametersProperty

Interface CfnRecipe.RecipeParametersProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getAggregateFunction

getBase

getCaseStatement

getCategoryMap

getCharsToRemove

getCollapseConsecutiveWhitespace

getColumnDataType

getColumnRange

getCount

getCustomCharacters

getCustomStopWords

getCustomValue

getDatasetsColumns

getDateAddValue

getDateTimeFormat

getDateTimeParameters

getDeleteOtherRows

getDelimiter

getEndPattern

getEndPosition

getEndValue

getExpandContractions

getExponent

getFalseString

getGroupByAggFunctionOptions

getGroupByColumns

getHiddenColumns

getIgnoreCase

getIncludeInSplit

getInput

getInterval

getIsText

getJoinKeys

getJoinType

getLeftColumns

getLimit

getLowerBound

getMapType

getModeType

getMultiLine

getNumRows

getNumRowsAfter

getNumRowsBefore

getOrderByColumn

getOrderByColumns

getOther

getPattern

getPatternOption1

getPatternOption2

getPatternOptions

getPeriod

getPosition

getRemoveAllPunctuation

getRemoveAllQuotes

getRemoveAllWhitespace

getRemoveCustomCharacters

getRemoveCustomValue

getRemoveLeadingAndTrailingPunctuation

getRemoveLeadingAndTrailingQuotes

getRemoveLeadingAndTrailingWhitespace

getRemoveLetters

getRemoveNumbers

getRemoveSourceColumn

getRemoveSpecialCharacters

getRightColumns

getSampleSize

getSampleType

getSecondaryInputs

getSecondInput

getSheetIndexes

getSheetNames

getSourceColumn

getSourceColumn1

getSourceColumn2

getSourceColumns