Class CfnRecipe.RecipeParametersProperty
Parameters that are used as inputs for various recipe actions.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.AWS.DataBrew.dll
Syntax (csharp)
public class RecipeParametersProperty : Object, CfnRecipe.IRecipeParametersProperty
Syntax (vb)
Public Class RecipeParametersProperty
Inherits Object
Implements CfnRecipe.IRecipeParametersProperty
Remarks
The parameters are specific to the context in which they're used.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataBrew;
var input;
var recipeParametersProperty = new 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 = new [] { new SecondaryInputProperty {
DataCatalogInputDefinition = new DataCatalogInputDefinitionProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
TableName = "tableName",
TempDirectory = new S3LocationProperty {
Bucket = "bucket",
// the properties below are optional
Key = "key"
}
},
S3InputDefinition = new S3LocationProperty {
Bucket = "bucket",
// the properties below are optional
Key = "key"
}
} },
SecondInput = "secondInput",
SheetIndexes = new [] { 123 },
SheetNames = new [] { "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"
};
Synopsis
Constructors
RecipeParametersProperty() |
Properties
AggregateFunction | The name of an aggregation function to apply. |
Base | The number of digits used in a counting system. |
CaseStatement | A case statement associated with a recipe. |
CategoryMap | A category map used for one-hot encoding. |
CharsToRemove | Characters to remove from a step that applies one-hot encoding or tokenization. |
CollapseConsecutiveWhitespace | Remove any non-word non-punctuation character. |
ColumnDataType | The data type of the column. |
ColumnRange | A range of columns to which a step is applied. |
Count | The number of times a string needs to be repeated. |
CustomCharacters | One or more characters that can be substituted or removed, depending on the context. |
CustomStopWords | A list of words to ignore in a step that applies word tokenization. |
CustomValue | A list of custom values to use in a step that requires that you provide a value to finish the operation. |
DatasetsColumns | A list of the dataset columns included in a project. |
DateAddValue | A value that specifies how many units of time to add or subtract for a date math operation. |
DateTimeFormat | A date format to apply to a date. |
DateTimeParameters | A set of parameters associated with a datetime. |
DeleteOtherRows | Determines whether unmapped rows in a categorical mapping should be deleted. |
Delimiter | The delimiter to use when parsing separated values in a text file. |
EndPattern | The end pattern to locate. |
EndPosition | The end position to locate. |
EndValue | The end value to locate. |
ExpandContractions | A list of word contractions and what they expand to. |
Exponent | The exponent to apply in an exponential operation. |
FalseString | A value that represents |
GroupByAggFunctionOptions | Specifies options to apply to the |
GroupByColumns | The columns to use in the |
HiddenColumns | A list of columns to hide. |
IgnoreCase | Indicates that lower and upper case letters are treated equally. |
IncludeInSplit | Indicates if this column is participating in a split transform. |
Input | The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog . |
Interval | The number of characters to split by. |
IsText | Indicates if the content is text. |
JoinKeys | The keys or columns involved in a join. |
JoinType | The type of join to use, for example, |
LeftColumns | The columns on the left side of the join. |
Limit | The number of times to perform |
LowerBound | The lower boundary for a value. |
MapType | The type of mappings to apply to construct a new dynamic frame. |
ModeType | Determines the manner in which mode value is calculated, in case there is more than one mode value. |
MultiLine | Specifies whether JSON input contains embedded new line characters. |
NumRows | The number of rows to consider in a window. |
NumRowsAfter | The number of rows to consider after the current row in a window. |
NumRowsBefore | The number of rows to consider before the current row in a window. |
OrderByColumn | A column to sort the results by. |
OrderByColumns | The columns to sort the results by. |
Other | The value to assign to unmapped cells, in categorical mapping. |
Pattern | The pattern to locate. |
PatternOption1 | The starting pattern to split between. |
PatternOption2 | The ending pattern to split between. |
PatternOptions | For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. |
Period | The size of the rolling window. |
Position | The character index within a string. |
RemoveAllPunctuation | If |
RemoveAllQuotes | If |
RemoveAllWhitespace | If |
RemoveCustomCharacters | If |
RemoveCustomValue | If |
RemoveLeadingAndTrailingPunctuation | If |
RemoveLeadingAndTrailingQuotes | If |
RemoveLeadingAndTrailingWhitespace | If |
RemoveLetters | If |
RemoveNumbers | If |
RemoveSourceColumn | If |
RemoveSpecialCharacters | If |
RightColumns | The columns on the right side of a join. |
SampleSize | The number of rows in the sample. |
SampleType | The sampling type to apply to the dataset. |
SecondaryInputs | A list of secondary inputs in a UNION transform. |
SecondInput | A object value to indicate the second dataset used in a join. |
SheetIndexes | One or more sheet numbers in the Excel file, which will be included in a dataset. |
SheetNames | Oone or more named sheets in the Excel file, which will be included in a dataset. |
SourceColumn | A source column needed for an operation, step, or transform. |
SourceColumn1 | A source column needed for an operation, step, or transform. |
SourceColumn2 | A source column needed for an operation, step, or transform. |
SourceColumns | A list of source columns needed for an operation, step, or transform. |
StartColumnIndex | The index number of the first column used by an operation, step, or transform. |
StartPattern | The starting pattern to locate. |
StartPosition | The starting position to locate. |
StartValue | The starting value to locate. |
StemmingMode | Indicates this operation uses stems and lemmas (base words) for word tokenization. |
StepCount | The total number of transforms in this recipe. |
StepIndex | The index ID of a step. |
StopWordsMode | Indicates this operation uses stop words as part of word tokenization. |
Strategy | The resolution strategy to apply in resolving ambiguities. |
TargetColumn | The column targeted by this operation. |
TargetColumnNames | The names to give columns altered by this operation. |
TargetDateFormat | The date format to convert to. |
TargetIndex | The index number of an object that is targeted by this operation. |
TimeZone | The current timezone that you want to use for dates. |
TokenizerPattern | A regex expression to use when splitting text into terms, also called words or tokens. |
TrueString | A value to use to represent |
UdfLang | The language that's used in the user-defined function. |
Units | Specifies a unit of time. |
UnpivotColumn | Cast columns as rows, so that each value is a different row in a single column. |
UpperBound | The upper boundary for a value. |
UseNewDataFrame | Create a new container to hold a dataset. |
Value | A static value that can be used in a comparison, a substitution, or in another context-specific way. |
Value1 | A value that's used by this operation. |
Value2 | A value that's used by this operation. |
ValueColumn | The column that is provided as a value that's used by this operation. |
ViewFrame | The subset of rows currently available for viewing. |
Constructors
RecipeParametersProperty()
public RecipeParametersProperty()
Properties
AggregateFunction
The name of an aggregation function to apply.
public string AggregateFunction { get; set; }
Property Value
System.String
Remarks
Base
The number of digits used in a counting system.
public string Base { get; set; }
Property Value
System.String
Remarks
CaseStatement
A case statement associated with a recipe.
public string CaseStatement { get; set; }
Property Value
System.String
Remarks
CategoryMap
A category map used for one-hot encoding.
public string CategoryMap { get; set; }
Property Value
System.String
Remarks
CharsToRemove
Characters to remove from a step that applies one-hot encoding or tokenization.
public string CharsToRemove { get; set; }
Property Value
System.String
Remarks
CollapseConsecutiveWhitespace
Remove any non-word non-punctuation character.
public string CollapseConsecutiveWhitespace { get; set; }
Property Value
System.String
Remarks
ColumnDataType
The data type of the column.
public string ColumnDataType { get; set; }
Property Value
System.String
Remarks
ColumnRange
A range of columns to which a step is applied.
public string ColumnRange { get; set; }
Property Value
System.String
Remarks
Count
The number of times a string needs to be repeated.
public string Count { get; set; }
Property Value
System.String
Remarks
CustomCharacters
One or more characters that can be substituted or removed, depending on the context.
public string CustomCharacters { get; set; }
Property Value
System.String
Remarks
CustomStopWords
A list of words to ignore in a step that applies word tokenization.
public string CustomStopWords { get; set; }
Property Value
System.String
Remarks
CustomValue
A list of custom values to use in a step that requires that you provide a value to finish the operation.
public string CustomValue { get; set; }
Property Value
System.String
Remarks
DatasetsColumns
A list of the dataset columns included in a project.
public string DatasetsColumns { get; set; }
Property Value
System.String
Remarks
DateAddValue
A value that specifies how many units of time to add or subtract for a date math operation.
public string DateAddValue { get; set; }
Property Value
System.String
Remarks
DateTimeFormat
A date format to apply to a date.
public string DateTimeFormat { get; set; }
Property Value
System.String
Remarks
DateTimeParameters
A set of parameters associated with a datetime.
public string DateTimeParameters { get; set; }
Property Value
System.String
Remarks
DeleteOtherRows
Determines whether unmapped rows in a categorical mapping should be deleted.
public string DeleteOtherRows { get; set; }
Property Value
System.String
Remarks
Delimiter
The delimiter to use when parsing separated values in a text file.
public string Delimiter { get; set; }
Property Value
System.String
Remarks
EndPattern
The end pattern to locate.
public string EndPattern { get; set; }
Property Value
System.String
Remarks
EndPosition
The end position to locate.
public string EndPosition { get; set; }
Property Value
System.String
Remarks
EndValue
The end value to locate.
public string EndValue { get; set; }
Property Value
System.String
Remarks
ExpandContractions
A list of word contractions and what they expand to.
public string ExpandContractions { get; set; }
Property Value
System.String
Remarks
For eample: can't ; cannot ; can not .
Exponent
The exponent to apply in an exponential operation.
public string Exponent { get; set; }
Property Value
System.String
Remarks
FalseString
A value that represents FALSE
.
public string FalseString { get; set; }
Property Value
System.String
Remarks
GroupByAggFunctionOptions
Specifies options to apply to the GROUP BY
used in an aggregation.
public string GroupByAggFunctionOptions { get; set; }
Property Value
System.String
Remarks
GroupByColumns
The columns to use in the GROUP BY
clause.
public string GroupByColumns { get; set; }
Property Value
System.String
Remarks
HiddenColumns
A list of columns to hide.
public string HiddenColumns { get; set; }
Property Value
System.String
Remarks
IgnoreCase
Indicates that lower and upper case letters are treated equally.
public string IgnoreCase { get; set; }
Property Value
System.String
Remarks
IncludeInSplit
Indicates if this column is participating in a split transform.
public string IncludeInSplit { get; set; }
Property Value
System.String
Remarks
Input
The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
public object Input { get; set; }
Property Value
System.Object
Remarks
Interval
The number of characters to split by.
public string Interval { get; set; }
Property Value
System.String
Remarks
IsText
Indicates if the content is text.
public string IsText { get; set; }
Property Value
System.String
Remarks
JoinKeys
The keys or columns involved in a join.
public string JoinKeys { get; set; }
Property Value
System.String
Remarks
JoinType
The type of join to use, for example, INNER JOIN
, OUTER JOIN
, and so on.
public string JoinType { get; set; }
Property Value
System.String
Remarks
LeftColumns
The columns on the left side of the join.
public string LeftColumns { get; set; }
Property Value
System.String
Remarks
Limit
The number of times to perform split
or replaceBy
in a string.
public string Limit { get; set; }
Property Value
System.String
Remarks
LowerBound
The lower boundary for a value.
public string LowerBound { get; set; }
Property Value
System.String
Remarks
MapType
The type of mappings to apply to construct a new dynamic frame.
public string MapType { get; set; }
Property Value
System.String
Remarks
ModeType
Determines the manner in which mode value is calculated, in case there is more than one mode value.
public string ModeType { get; set; }
Property Value
System.String
Remarks
Valid values: NONE
| AVERAGE
| MINIMUM
| MAXIMUM
MultiLine
Specifies whether JSON input contains embedded new line characters.
public object MultiLine { get; set; }
Property Value
System.Object
Remarks
NumRows
The number of rows to consider in a window.
public string NumRows { get; set; }
Property Value
System.String
Remarks
NumRowsAfter
The number of rows to consider after the current row in a window.
public string NumRowsAfter { get; set; }
Property Value
System.String
Remarks
NumRowsBefore
The number of rows to consider before the current row in a window.
public string NumRowsBefore { get; set; }
Property Value
System.String
Remarks
OrderByColumn
A column to sort the results by.
public string OrderByColumn { get; set; }
Property Value
System.String
Remarks
OrderByColumns
The columns to sort the results by.
public string OrderByColumns { get; set; }
Property Value
System.String
Remarks
Other
The value to assign to unmapped cells, in categorical mapping.
public string Other { get; set; }
Property Value
System.String
Remarks
Pattern
The pattern to locate.
public string Pattern { get; set; }
Property Value
System.String
Remarks
PatternOption1
The starting pattern to split between.
public string PatternOption1 { get; set; }
Property Value
System.String
Remarks
PatternOption2
The ending pattern to split between.
public string PatternOption2 { get; set; }
Property Value
System.String
Remarks
PatternOptions
For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.
public string PatternOptions { get; set; }
Property Value
System.String
Remarks
For example: [{"pattern":"1","includeInSplit":true}]
Period
The size of the rolling window.
public string Period { get; set; }
Property Value
System.String
Remarks
Position
The character index within a string.
public string Position { get; set; }
Property Value
System.String
Remarks
RemoveAllPunctuation
If true
, removes all of the following characters: .
.!
.,
.?
.
public string RemoveAllPunctuation { get; set; }
Property Value
System.String
Remarks
RemoveAllQuotes
If true
, removes all single quotes and double quotes.
public string RemoveAllQuotes { get; set; }
Property Value
System.String
Remarks
RemoveAllWhitespace
If true
, removes all whitespaces from the value.
public string RemoveAllWhitespace { get; set; }
Property Value
System.String
Remarks
RemoveCustomCharacters
If true
, removes all chraracters specified by CustomCharacters
.
public string RemoveCustomCharacters { get; set; }
Property Value
System.String
Remarks
RemoveCustomValue
If true
, removes all chraracters specified by CustomValue
.
public string RemoveCustomValue { get; set; }
Property Value
System.String
Remarks
RemoveLeadingAndTrailingPunctuation
If true
, removes the following characters if they occur at the start or end of the value: .
!
,
?
.
public string RemoveLeadingAndTrailingPunctuation { get; set; }
Property Value
System.String
Remarks
RemoveLeadingAndTrailingQuotes
If true
, removes single quotes and double quotes from the beginning and end of the value.
public string RemoveLeadingAndTrailingQuotes { get; set; }
Property Value
System.String
Remarks
RemoveLeadingAndTrailingWhitespace
If true
, removes all whitespaces from the beginning and end of the value.
public string RemoveLeadingAndTrailingWhitespace { get; set; }
Property Value
System.String
Remarks
RemoveLetters
If true
, removes all uppercase and lowercase alphabetic characters (A through Z;
public string RemoveLetters { get; set; }
Property Value
System.String
Remarks
RemoveNumbers
If true
, removes all numeric characters (0 through 9).
public string RemoveNumbers { get; set; }
Property Value
System.String
Remarks
RemoveSourceColumn
If true
, the source column will be removed after un-nesting that column.
public string RemoveSourceColumn { get; set; }
Property Value
System.String
Remarks
(Used with nested column types, such as Map, Struct, or Array.)
RemoveSpecialCharacters
If true
, removes all of the following characters: `!
public string RemoveSpecialCharacters { get; set; }
Property Value
System.String
Remarks
" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~
RightColumns
The columns on the right side of a join.
public string RightColumns { get; set; }
Property Value
System.String
Remarks
SampleSize
The number of rows in the sample.
public string SampleSize { get; set; }
Property Value
System.String
Remarks
SampleType
The sampling type to apply to the dataset.
public string SampleType { get; set; }
Property Value
System.String
Remarks
Valid values: FIRST_N
| LAST_N
| RANDOM
SecondaryInputs
A list of secondary inputs in a UNION transform.
public object SecondaryInputs { get; set; }
Property Value
System.Object
Remarks
SecondInput
A object value to indicate the second dataset used in a join.
public string SecondInput { get; set; }
Property Value
System.String
Remarks
SheetIndexes
One or more sheet numbers in the Excel file, which will be included in a dataset.
public object SheetIndexes { get; set; }
Property Value
System.Object
Remarks
SheetNames
Oone or more named sheets in the Excel file, which will be included in a dataset.
public string[] SheetNames { get; set; }
Property Value
System.String[]
Remarks
SourceColumn
A source column needed for an operation, step, or transform.
public string SourceColumn { get; set; }
Property Value
System.String
Remarks
SourceColumn1
A source column needed for an operation, step, or transform.
public string SourceColumn1 { get; set; }
Property Value
System.String
Remarks
SourceColumn2
A source column needed for an operation, step, or transform.
public string SourceColumn2 { get; set; }
Property Value
System.String
Remarks
SourceColumns
A list of source columns needed for an operation, step, or transform.
public string SourceColumns { get; set; }
Property Value
System.String
Remarks
StartColumnIndex
The index number of the first column used by an operation, step, or transform.
public string StartColumnIndex { get; set; }
Property Value
System.String
Remarks
StartPattern
The starting pattern to locate.
public string StartPattern { get; set; }
Property Value
System.String
Remarks
StartPosition
The starting position to locate.
public string StartPosition { get; set; }
Property Value
System.String
Remarks
StartValue
The starting value to locate.
public string StartValue { get; set; }
Property Value
System.String
Remarks
StemmingMode
Indicates this operation uses stems and lemmas (base words) for word tokenization.
public string StemmingMode { get; set; }
Property Value
System.String
Remarks
StepCount
The total number of transforms in this recipe.
public string StepCount { get; set; }
Property Value
System.String
Remarks
StepIndex
The index ID of a step.
public string StepIndex { get; set; }
Property Value
System.String
Remarks
StopWordsMode
Indicates this operation uses stop words as part of word tokenization.
public string StopWordsMode { get; set; }
Property Value
System.String
Remarks
Strategy
The resolution strategy to apply in resolving ambiguities.
public string Strategy { get; set; }
Property Value
System.String
Remarks
TargetColumn
The column targeted by this operation.
public string TargetColumn { get; set; }
Property Value
System.String
Remarks
TargetColumnNames
The names to give columns altered by this operation.
public string TargetColumnNames { get; set; }
Property Value
System.String
Remarks
TargetDateFormat
The date format to convert to.
public string TargetDateFormat { get; set; }
Property Value
System.String
Remarks
TargetIndex
The index number of an object that is targeted by this operation.
public string TargetIndex { get; set; }
Property Value
System.String
Remarks
TimeZone
The current timezone that you want to use for dates.
public string TimeZone { get; set; }
Property Value
System.String
Remarks
TokenizerPattern
A regex expression to use when splitting text into terms, also called words or tokens.
public string TokenizerPattern { get; set; }
Property Value
System.String
Remarks
TrueString
A value to use to represent TRUE
.
public string TrueString { get; set; }
Property Value
System.String
Remarks
UdfLang
The language that's used in the user-defined function.
public string UdfLang { get; set; }
Property Value
System.String
Remarks
Units
Specifies a unit of time.
public string Units { get; set; }
Property Value
System.String
Remarks
For example: MINUTES
; SECONDS
; HOURS
; etc.
UnpivotColumn
Cast columns as rows, so that each value is a different row in a single column.
public string UnpivotColumn { get; set; }
Property Value
System.String
Remarks
UpperBound
The upper boundary for a value.
public string UpperBound { get; set; }
Property Value
System.String
Remarks
UseNewDataFrame
Create a new container to hold a dataset.
public string UseNewDataFrame { get; set; }
Property Value
System.String
Remarks
Value
A static value that can be used in a comparison, a substitution, or in another context-specific way.
public string Value { get; set; }
Property Value
System.String
Remarks
A Value
can be a number, string, or other datatype, depending on the recipe action in which it's used.
Value1
A value that's used by this operation.
public string Value1 { get; set; }
Property Value
System.String
Remarks
Value2
A value that's used by this operation.
public string Value2 { get; set; }
Property Value
System.String
Remarks
ValueColumn
The column that is provided as a value that's used by this operation.
public string ValueColumn { get; set; }
Property Value
System.String
Remarks
ViewFrame
The subset of rows currently available for viewing.
public string ViewFrame { get; set; }
Property Value
System.String