Interface CfnRecipe.IRecipeParametersProperty

Parameters that are used as inputs for various recipe actions.

Namespace: Amazon.CDK.AWS.DataBrew

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IRecipeParametersProperty

Syntax (vb)

Public Interface IRecipeParametersProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html

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

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 `FALSE` .
GroupByAggFunctionOptions	Specifies options to apply to the `GROUP BY` used in an aggregation.
GroupByColumns	The columns to use in the `GROUP BY` clause.
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, `INNER JOIN` , `OUTER JOIN` , and so on.
LeftColumns	The columns on the left side of the join.
Limit	The number of times to perform `split` or `replaceBy` in a string.
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 `true` , removes all of the following characters: `.` `.!` `.,` `.?`.
RemoveAllQuotes	If `true` , removes all single quotes and double quotes.
RemoveAllWhitespace	If `true` , removes all whitespaces from the value.
RemoveCustomCharacters	If `true` , removes all chraracters specified by `CustomCharacters` .
RemoveCustomValue	If `true` , removes all chraracters specified by `CustomValue` .
RemoveLeadingAndTrailingPunctuation	If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`.
RemoveLeadingAndTrailingQuotes	If `true` , removes single quotes and double quotes from the beginning and end of the value.
RemoveLeadingAndTrailingWhitespace	If `true` , removes all whitespaces from the beginning and end of the value.
RemoveLetters	If `true` , removes all uppercase and lowercase alphabetic characters (A through Z;
RemoveNumbers	If `true` , removes all numeric characters (0 through 9).
RemoveSourceColumn	If `true` , the source column will be removed after un-nesting that column.
RemoveSpecialCharacters	If `true` , removes all of the following characters: `!
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 `TRUE` .
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.

Properties

AggregateFunction

The name of an aggregation function to apply.

virtual string AggregateFunction { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-aggregatefunction

Base

The number of digits used in a counting system.

virtual string Base { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-base

CaseStatement

A case statement associated with a recipe.

virtual string CaseStatement { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-casestatement

CategoryMap

A category map used for one-hot encoding.

virtual string CategoryMap { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-categorymap

CharsToRemove

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

virtual string CharsToRemove { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-charstoremove

CollapseConsecutiveWhitespace

Remove any non-word non-punctuation character.

virtual string CollapseConsecutiveWhitespace { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-collapseconsecutivewhitespace

ColumnDataType

The data type of the column.

virtual string ColumnDataType { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-columndatatype

ColumnRange

A range of columns to which a step is applied.

virtual string ColumnRange { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-columnrange

Count

The number of times a string needs to be repeated.

virtual string Count { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-count

CustomCharacters

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

virtual string CustomCharacters { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customcharacters

CustomStopWords

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

virtual string CustomStopWords { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customstopwords

CustomValue

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

virtual string CustomValue { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-customvalue

DatasetsColumns

A list of the dataset columns included in a project.

virtual string DatasetsColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datasetscolumns

DateAddValue

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

virtual string DateAddValue { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-dateaddvalue

DateTimeFormat

A date format to apply to a date.

virtual string DateTimeFormat { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datetimeformat

DateTimeParameters

A set of parameters associated with a datetime.

virtual string DateTimeParameters { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-datetimeparameters

DeleteOtherRows

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

virtual string DeleteOtherRows { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-deleteotherrows

Delimiter

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

virtual string Delimiter { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-delimiter

EndPattern

The end pattern to locate.

virtual string EndPattern { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endpattern

EndPosition

The end position to locate.

virtual string EndPosition { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endposition

EndValue

The end value to locate.

virtual string EndValue { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-endvalue

ExpandContractions

A list of word contractions and what they expand to.

virtual string ExpandContractions { get; }

Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-expandcontractions

Exponent

The exponent to apply in an exponential operation.

virtual string Exponent { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-exponent

FalseString

A value that represents FALSE .

virtual string FalseString { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-falsestring

GroupByAggFunctionOptions

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

virtual string GroupByAggFunctionOptions { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-groupbyaggfunctionoptions

GroupByColumns

The columns to use in the GROUP BY clause.

virtual string GroupByColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-groupbycolumns

HiddenColumns

A list of columns to hide.

virtual string HiddenColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-hiddencolumns

IgnoreCase

Indicates that lower and upper case letters are treated equally.

virtual string IgnoreCase { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-ignorecase

IncludeInSplit

Indicates if this column is participating in a split transform.

virtual string IncludeInSplit { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-includeinsplit

Input

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

virtual object Input { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-input

Interval

The number of characters to split by.

virtual string Interval { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-interval

IsText

Indicates if the content is text.

virtual string IsText { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-istext

JoinKeys

The keys or columns involved in a join.

virtual string JoinKeys { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-joinkeys

JoinType

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

virtual string JoinType { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-jointype

LeftColumns

The columns on the left side of the join.

virtual string LeftColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-leftcolumns

Limit

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

virtual string Limit { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-limit

LowerBound

The lower boundary for a value.

virtual string LowerBound { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-lowerbound

MapType

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

virtual string MapType { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-maptype

ModeType

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

virtual string ModeType { get; }

Property Value

System.String

Remarks

Valid values: NONE | AVERAGE | MINIMUM | MAXIMUM

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-modetype

MultiLine

Specifies whether JSON input contains embedded new line characters.

virtual object MultiLine { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-multiline

NumRows

The number of rows to consider in a window.

virtual string NumRows { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrows

NumRowsAfter

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

virtual string NumRowsAfter { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrowsafter

NumRowsBefore

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

virtual string NumRowsBefore { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-numrowsbefore

OrderByColumn

A column to sort the results by.

virtual string OrderByColumn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-orderbycolumn

OrderByColumns

The columns to sort the results by.

virtual string OrderByColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-orderbycolumns

Other

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

virtual string Other { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-other

Pattern

The pattern to locate.

virtual string Pattern { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-pattern

PatternOption1

The starting pattern to split between.

virtual string PatternOption1 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoption1

PatternOption2

The ending pattern to split between.

virtual string PatternOption2 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoption2

PatternOptions

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

virtual string PatternOptions { get; }

Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-patternoptions

Period

The size of the rolling window.

virtual string Period { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-period

Position

The character index within a string.

virtual string Position { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-position

RemoveAllPunctuation

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

virtual string RemoveAllPunctuation { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallpunctuation

RemoveAllQuotes

If true , removes all single quotes and double quotes.

virtual string RemoveAllQuotes { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallquotes

RemoveAllWhitespace

If true , removes all whitespaces from the value.

virtual string RemoveAllWhitespace { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeallwhitespace

RemoveCustomCharacters

If true , removes all chraracters specified by CustomCharacters .

virtual string RemoveCustomCharacters { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removecustomcharacters

RemoveCustomValue

If true , removes all chraracters specified by CustomValue .

virtual string RemoveCustomValue { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removecustomvalue

RemoveLeadingAndTrailingPunctuation

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

virtual string RemoveLeadingAndTrailingPunctuation { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingpunctuation

RemoveLeadingAndTrailingQuotes

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

virtual string RemoveLeadingAndTrailingQuotes { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingquotes

RemoveLeadingAndTrailingWhitespace

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

virtual string RemoveLeadingAndTrailingWhitespace { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeleadingandtrailingwhitespace

RemoveLetters

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

virtual string RemoveLetters { get; }

Property Value

System.String

Remarks

a through z).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removeletters

RemoveNumbers

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

virtual string RemoveNumbers { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removenumbers

RemoveSourceColumn

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

virtual string RemoveSourceColumn { get; }

Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removesourcecolumn

RemoveSpecialCharacters

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

virtual string RemoveSpecialCharacters { get; }

Property Value

System.String

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-removespecialcharacters

RightColumns

The columns on the right side of a join.

virtual string RightColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-rightcolumns

SampleSize

The number of rows in the sample.

virtual string SampleSize { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-samplesize

SampleType

The sampling type to apply to the dataset.

virtual string SampleType { get; }

Property Value

System.String

Remarks

Valid values: FIRST_N | LAST_N | RANDOM

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sampletype

SecondaryInputs

A list of secondary inputs in a UNION transform.

virtual object SecondaryInputs { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-secondaryinputs

SecondInput

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

virtual string SecondInput { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-secondinput

SheetIndexes

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

virtual object SheetIndexes { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sheetindexes

SheetNames

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

virtual string[] SheetNames { get; }

Property Value

System.String[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sheetnames

SourceColumn

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

virtual string SourceColumn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn

SourceColumn1

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

virtual string SourceColumn1 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn1

SourceColumn2

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

virtual string SourceColumn2 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumn2

SourceColumns

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

virtual string SourceColumns { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-sourcecolumns

StartColumnIndex

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

virtual string StartColumnIndex { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startcolumnindex

StartPattern

The starting pattern to locate.

virtual string StartPattern { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startpattern

StartPosition

The starting position to locate.

virtual string StartPosition { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startposition

StartValue

The starting value to locate.

virtual string StartValue { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-startvalue

StemmingMode

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

virtual string StemmingMode { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stemmingmode

StepCount

The total number of transforms in this recipe.

virtual string StepCount { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stepcount

StepIndex

The index ID of a step.

virtual string StepIndex { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stepindex

StopWordsMode

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

virtual string StopWordsMode { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-stopwordsmode

Strategy

The resolution strategy to apply in resolving ambiguities.

virtual string Strategy { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-strategy

TargetColumn

The column targeted by this operation.

virtual string TargetColumn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetcolumn

TargetColumnNames

The names to give columns altered by this operation.

virtual string TargetColumnNames { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetcolumnnames

TargetDateFormat

The date format to convert to.

virtual string TargetDateFormat { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetdateformat

TargetIndex

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

virtual string TargetIndex { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-targetindex

TimeZone

The current timezone that you want to use for dates.

virtual string TimeZone { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-timezone

TokenizerPattern

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

virtual string TokenizerPattern { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-tokenizerpattern

TrueString

A value to use to represent TRUE .

virtual string TrueString { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-truestring

UdfLang

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

virtual string UdfLang { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-udflang

Units

Specifies a unit of time.

virtual string Units { get; }

Property Value

System.String

Remarks

For example: MINUTES ; SECONDS ; HOURS ; etc.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-units

UnpivotColumn

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

virtual string UnpivotColumn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-unpivotcolumn

UpperBound

The upper boundary for a value.

virtual string UpperBound { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-upperbound

UseNewDataFrame

Create a new container to hold a dataset.

virtual string UseNewDataFrame { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-usenewdataframe

Value

A static value that can be used in a comparison, a substitution, or in another context-specific way.

virtual string Value { get; }

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value

Value1

A value that's used by this operation.

virtual string Value1 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value1

Value2

A value that's used by this operation.

virtual string Value2 { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-value2

ValueColumn

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

virtual string ValueColumn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-valuecolumn

ViewFrame

The subset of rows currently available for viewing.

virtual string ViewFrame { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html#cfn-databrew-recipe-recipeparameters-viewframe

Select your cookie preferences

Interface CfnRecipe.IRecipeParametersProperty

Namespace: Amazon.CDK.AWS.DataBrew

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

Syntax (vb)

Remarks

Examples

Synopsis

Properties

Properties

AggregateFunction

Property Value

Remarks

Base

Property Value

Remarks

CaseStatement

Property Value

Remarks

CategoryMap

Property Value

Remarks

CharsToRemove

Property Value

Remarks

CollapseConsecutiveWhitespace

Property Value

Remarks

ColumnDataType

Property Value

Remarks

ColumnRange

Property Value

Remarks

Count

Property Value

Remarks

CustomCharacters

Property Value

Remarks

CustomStopWords

Property Value

Remarks

CustomValue

Property Value

Remarks

DatasetsColumns

Property Value

Remarks

DateAddValue

Property Value

Remarks

DateTimeFormat

Property Value

Remarks

DateTimeParameters

Property Value

Remarks

DeleteOtherRows

Property Value

Remarks

Delimiter

Property Value

Remarks

EndPattern

Property Value

Remarks

EndPosition

Property Value

Remarks

EndValue

Property Value

Remarks

ExpandContractions

Property Value

Remarks

Exponent

Property Value

Remarks