1. Packages
  2. AWS Native
  3. API Docs
  4. databrew
  5. getRecipe

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.databrew.getRecipe

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Resource schema for AWS::DataBrew::Recipe.

    Using getRecipe

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecipe(args: GetRecipeArgs, opts?: InvokeOptions): Promise<GetRecipeResult>
    function getRecipeOutput(args: GetRecipeOutputArgs, opts?: InvokeOptions): Output<GetRecipeResult>
    def get_recipe(name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRecipeResult
    def get_recipe_output(name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRecipeResult]
    func LookupRecipe(ctx *Context, args *LookupRecipeArgs, opts ...InvokeOption) (*LookupRecipeResult, error)
    func LookupRecipeOutput(ctx *Context, args *LookupRecipeOutputArgs, opts ...InvokeOption) LookupRecipeResultOutput

    > Note: This function is named LookupRecipe in the Go SDK.

    public static class GetRecipe 
    {
        public static Task<GetRecipeResult> InvokeAsync(GetRecipeArgs args, InvokeOptions? opts = null)
        public static Output<GetRecipeResult> Invoke(GetRecipeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRecipeResult> getRecipe(GetRecipeArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:databrew:getRecipe
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Recipe name
    Name string
    Recipe name
    name String
    Recipe name
    name string
    Recipe name
    name str
    Recipe name
    name String
    Recipe name

    getRecipe Result

    The following output properties are available:

    Description string
    Description of the recipe
    Steps []RecipeStep
    description String
    Description of the recipe
    steps List<RecipeStep>
    description string
    Description of the recipe
    steps RecipeStep[]
    description str
    Description of the recipe
    steps Sequence[RecipeStep]
    description String
    Description of the recipe
    steps List<Property Map>

    Supporting Types

    RecipeAction

    operation String
    Step action operation
    parameters Property Map | Property Map

    RecipeConditionExpression

    Condition string
    Input condition to be applied to the target column
    TargetColumn string
    Name of the target column
    Value string
    Value of the condition
    Condition string
    Input condition to be applied to the target column
    TargetColumn string
    Name of the target column
    Value string
    Value of the condition
    condition String
    Input condition to be applied to the target column
    targetColumn String
    Name of the target column
    value String
    Value of the condition
    condition string
    Input condition to be applied to the target column
    targetColumn string
    Name of the target column
    value string
    Value of the condition
    condition str
    Input condition to be applied to the target column
    target_column str
    Name of the target column
    value str
    Value of the condition
    condition String
    Input condition to be applied to the target column
    targetColumn String
    Name of the target column
    value String
    Value of the condition

    RecipeDataCatalogInputDefinition

    CatalogId string
    Catalog id
    DatabaseName string
    Database name
    TableName string
    Table name
    TempDirectory RecipeS3Location
    catalogId String
    Catalog id
    databaseName String
    Database name
    tableName String
    Table name
    tempDirectory RecipeS3Location
    catalogId string
    Catalog id
    databaseName string
    Database name
    tableName string
    Table name
    tempDirectory RecipeS3Location
    catalog_id str
    Catalog id
    database_name str
    Database name
    table_name str
    Table name
    temp_directory RecipeS3Location
    catalogId String
    Catalog id
    databaseName String
    Database name
    tableName String
    Table name
    tempDirectory Property Map

    RecipeParameters

    AggregateFunction string
    Base string
    CaseStatement string
    CategoryMap string
    CharsToRemove string
    CollapseConsecutiveWhitespace string
    ColumnDataType string
    ColumnRange string
    Count string
    CustomCharacters string
    CustomStopWords string
    CustomValue string
    DatasetsColumns string
    DateAddValue string
    DateTimeFormat string
    DateTimeParameters string
    DeleteOtherRows string
    Delimiter string
    EndPattern string
    EndPosition string
    EndValue string
    ExpandContractions string
    Exponent string
    FalseString string
    GroupByAggFunctionOptions string
    GroupByColumns string
    HiddenColumns string
    IgnoreCase string
    IncludeInSplit string
    Input Pulumi.AwsNative.DataBrew.Inputs.RecipeParametersInputProperties
    Input
    Interval string
    IsText string
    JoinKeys string
    JoinType string
    LeftColumns string
    Limit string
    LowerBound string
    MapType string
    ModeType string
    MultiLine bool
    NumRows string
    NumRowsAfter string
    NumRowsBefore string
    OrderByColumn string
    OrderByColumns string
    Other string
    Pattern string
    PatternOption1 string
    PatternOption2 string
    PatternOptions string
    Period string
    Position string
    RemoveAllPunctuation string
    RemoveAllQuotes string
    RemoveAllWhitespace string
    RemoveCustomCharacters string
    RemoveCustomValue string
    RemoveLeadingAndTrailingPunctuation string
    RemoveLeadingAndTrailingQuotes string
    RemoveLeadingAndTrailingWhitespace string
    RemoveLetters string
    RemoveNumbers string
    RemoveSourceColumn string
    RemoveSpecialCharacters string
    RightColumns string
    SampleSize string
    SampleType string
    SecondInput string
    SecondaryInputs List<Pulumi.AwsNative.DataBrew.Inputs.RecipeSecondaryInput>
    SheetIndexes List<int>
    SheetNames List<string>
    SourceColumn string
    SourceColumn1 string
    SourceColumn2 string
    SourceColumns string
    StartColumnIndex string
    StartPattern string
    StartPosition string
    StartValue string
    StemmingMode string
    StepCount string
    StepIndex string
    StopWordsMode string
    Strategy string
    TargetColumn string
    TargetColumnNames string
    TargetDateFormat string
    TargetIndex string
    TimeZone string
    TokenizerPattern string
    TrueString string
    UdfLang string
    Units string
    UnpivotColumn string
    UpperBound string
    UseNewDataFrame string
    Value string
    Value1 string
    Value2 string
    ValueColumn string
    ViewFrame string
    AggregateFunction string
    Base string
    CaseStatement string
    CategoryMap string
    CharsToRemove string
    CollapseConsecutiveWhitespace string
    ColumnDataType string
    ColumnRange string
    Count string
    CustomCharacters string
    CustomStopWords string
    CustomValue string
    DatasetsColumns string
    DateAddValue string
    DateTimeFormat string
    DateTimeParameters string
    DeleteOtherRows string
    Delimiter string
    EndPattern string
    EndPosition string
    EndValue string
    ExpandContractions string
    Exponent string
    FalseString string
    GroupByAggFunctionOptions string
    GroupByColumns string
    HiddenColumns string
    IgnoreCase string
    IncludeInSplit string
    Input RecipeParametersInputProperties
    Input
    Interval string
    IsText string
    JoinKeys string
    JoinType string
    LeftColumns string
    Limit string
    LowerBound string
    MapType string
    ModeType string
    MultiLine bool
    NumRows string
    NumRowsAfter string
    NumRowsBefore string
    OrderByColumn string
    OrderByColumns string
    Other string
    Pattern string
    PatternOption1 string
    PatternOption2 string
    PatternOptions string
    Period string
    Position string
    RemoveAllPunctuation string
    RemoveAllQuotes string
    RemoveAllWhitespace string
    RemoveCustomCharacters string
    RemoveCustomValue string
    RemoveLeadingAndTrailingPunctuation string
    RemoveLeadingAndTrailingQuotes string
    RemoveLeadingAndTrailingWhitespace string
    RemoveLetters string
    RemoveNumbers string
    RemoveSourceColumn string
    RemoveSpecialCharacters string
    RightColumns string
    SampleSize string
    SampleType string
    SecondInput string
    SecondaryInputs []RecipeSecondaryInput
    SheetIndexes []int
    SheetNames []string
    SourceColumn string
    SourceColumn1 string
    SourceColumn2 string
    SourceColumns string
    StartColumnIndex string
    StartPattern string
    StartPosition string
    StartValue string
    StemmingMode string
    StepCount string
    StepIndex string
    StopWordsMode string
    Strategy string
    TargetColumn string
    TargetColumnNames string
    TargetDateFormat string
    TargetIndex string
    TimeZone string
    TokenizerPattern string
    TrueString string
    UdfLang string
    Units string
    UnpivotColumn string
    UpperBound string
    UseNewDataFrame string
    Value string
    Value1 string
    Value2 string
    ValueColumn string
    ViewFrame string
    aggregateFunction String
    base String
    caseStatement String
    categoryMap String
    charsToRemove String
    collapseConsecutiveWhitespace String
    columnDataType String
    columnRange String
    count String
    customCharacters String
    customStopWords String
    customValue String
    datasetsColumns String
    dateAddValue String
    dateTimeFormat String
    dateTimeParameters String
    deleteOtherRows String
    delimiter String
    endPattern String
    endPosition String
    endValue String
    expandContractions String
    exponent String
    falseString String
    groupByAggFunctionOptions String
    groupByColumns String
    hiddenColumns String
    ignoreCase String
    includeInSplit String
    input RecipeParametersInputProperties
    Input
    interval String
    isText String
    joinKeys String
    joinType String
    leftColumns String
    limit String
    lowerBound String
    mapType String
    modeType String
    multiLine Boolean
    numRows String
    numRowsAfter String
    numRowsBefore String
    orderByColumn String
    orderByColumns String
    other String
    pattern String
    patternOption1 String
    patternOption2 String
    patternOptions String
    period String
    position String
    removeAllPunctuation String
    removeAllQuotes String
    removeAllWhitespace String
    removeCustomCharacters String
    removeCustomValue String
    removeLeadingAndTrailingPunctuation String
    removeLeadingAndTrailingQuotes String
    removeLeadingAndTrailingWhitespace String
    removeLetters String
    removeNumbers String
    removeSourceColumn String
    removeSpecialCharacters String
    rightColumns String
    sampleSize String
    sampleType String
    secondInput String
    secondaryInputs List<RecipeSecondaryInput>
    sheetIndexes List<Integer>
    sheetNames List<String>
    sourceColumn String
    sourceColumn1 String
    sourceColumn2 String
    sourceColumns String
    startColumnIndex String
    startPattern String
    startPosition String
    startValue String
    stemmingMode String
    stepCount String
    stepIndex String
    stopWordsMode String
    strategy String
    targetColumn String
    targetColumnNames String
    targetDateFormat String
    targetIndex String
    timeZone String
    tokenizerPattern String
    trueString String
    udfLang String
    units String
    unpivotColumn String
    upperBound String
    useNewDataFrame String
    value String
    value1 String
    value2 String
    valueColumn String
    viewFrame String
    aggregateFunction string
    base string
    caseStatement string
    categoryMap string
    charsToRemove string
    collapseConsecutiveWhitespace string
    columnDataType string
    columnRange string
    count string
    customCharacters string
    customStopWords string
    customValue string
    datasetsColumns string
    dateAddValue string
    dateTimeFormat string
    dateTimeParameters string
    deleteOtherRows string
    delimiter string
    endPattern string
    endPosition string
    endValue string
    expandContractions string
    exponent string
    falseString string
    groupByAggFunctionOptions string
    groupByColumns string
    hiddenColumns string
    ignoreCase string
    includeInSplit string
    input RecipeParametersInputProperties
    Input
    interval string
    isText string
    joinKeys string
    joinType string
    leftColumns string
    limit string
    lowerBound string
    mapType string
    modeType string
    multiLine boolean
    numRows string
    numRowsAfter string
    numRowsBefore string
    orderByColumn string
    orderByColumns string
    other string
    pattern string
    patternOption1 string
    patternOption2 string
    patternOptions string
    period string
    position string
    removeAllPunctuation string
    removeAllQuotes string
    removeAllWhitespace string
    removeCustomCharacters string
    removeCustomValue string
    removeLeadingAndTrailingPunctuation string
    removeLeadingAndTrailingQuotes string
    removeLeadingAndTrailingWhitespace string
    removeLetters string
    removeNumbers string
    removeSourceColumn string
    removeSpecialCharacters string
    rightColumns string
    sampleSize string
    sampleType string
    secondInput string
    secondaryInputs RecipeSecondaryInput[]
    sheetIndexes number[]
    sheetNames string[]
    sourceColumn string
    sourceColumn1 string
    sourceColumn2 string
    sourceColumns string
    startColumnIndex string
    startPattern string
    startPosition string
    startValue string
    stemmingMode string
    stepCount string
    stepIndex string
    stopWordsMode string
    strategy string
    targetColumn string
    targetColumnNames string
    targetDateFormat string
    targetIndex string
    timeZone string
    tokenizerPattern string
    trueString string
    udfLang string
    units string
    unpivotColumn string
    upperBound string
    useNewDataFrame string
    value string
    value1 string
    value2 string
    valueColumn string
    viewFrame string
    aggregate_function str
    base str
    case_statement str
    category_map str
    chars_to_remove str
    collapse_consecutive_whitespace str
    column_data_type str
    column_range str
    count str
    custom_characters str
    custom_stop_words str
    custom_value str
    datasets_columns str
    date_add_value str
    date_time_format str
    date_time_parameters str
    delete_other_rows str
    delimiter str
    end_pattern str
    end_position str
    end_value str
    expand_contractions str
    exponent str
    false_string str
    group_by_agg_function_options str
    group_by_columns str
    hidden_columns str
    ignore_case str
    include_in_split str
    input RecipeParametersInputProperties
    Input
    interval str
    is_text str
    join_keys str
    join_type str
    left_columns str
    limit str
    lower_bound str
    map_type str
    mode_type str
    multi_line bool
    num_rows str
    num_rows_after str
    num_rows_before str
    order_by_column str
    order_by_columns str
    other str
    pattern str
    pattern_option1 str
    pattern_option2 str
    pattern_options str
    period str
    position str
    remove_all_punctuation str
    remove_all_quotes str
    remove_all_whitespace str
    remove_custom_characters str
    remove_custom_value str
    remove_leading_and_trailing_punctuation str
    remove_leading_and_trailing_quotes str
    remove_leading_and_trailing_whitespace str
    remove_letters str
    remove_numbers str
    remove_source_column str
    remove_special_characters str
    right_columns str
    sample_size str
    sample_type str
    second_input str
    secondary_inputs Sequence[RecipeSecondaryInput]
    sheet_indexes Sequence[int]
    sheet_names Sequence[str]
    source_column str
    source_column1 str
    source_column2 str
    source_columns str
    start_column_index str
    start_pattern str
    start_position str
    start_value str
    stemming_mode str
    step_count str
    step_index str
    stop_words_mode str
    strategy str
    target_column str
    target_column_names str
    target_date_format str
    target_index str
    time_zone str
    tokenizer_pattern str
    true_string str
    udf_lang str
    units str
    unpivot_column str
    upper_bound str
    use_new_data_frame str
    value str
    value1 str
    value2 str
    value_column str
    view_frame str
    aggregateFunction String
    base String
    caseStatement String
    categoryMap String
    charsToRemove String
    collapseConsecutiveWhitespace String
    columnDataType String
    columnRange String
    count String
    customCharacters String
    customStopWords String
    customValue String
    datasetsColumns String
    dateAddValue String
    dateTimeFormat String
    dateTimeParameters String
    deleteOtherRows String
    delimiter String
    endPattern String
    endPosition String
    endValue String
    expandContractions String
    exponent String
    falseString String
    groupByAggFunctionOptions String
    groupByColumns String
    hiddenColumns String
    ignoreCase String
    includeInSplit String
    input Property Map
    Input
    interval String
    isText String
    joinKeys String
    joinType String
    leftColumns String
    limit String
    lowerBound String
    mapType String
    modeType String
    multiLine Boolean
    numRows String
    numRowsAfter String
    numRowsBefore String
    orderByColumn String
    orderByColumns String
    other String
    pattern String
    patternOption1 String
    patternOption2 String
    patternOptions String
    period String
    position String
    removeAllPunctuation String
    removeAllQuotes String
    removeAllWhitespace String
    removeCustomCharacters String
    removeCustomValue String
    removeLeadingAndTrailingPunctuation String
    removeLeadingAndTrailingQuotes String
    removeLeadingAndTrailingWhitespace String
    removeLetters String
    removeNumbers String
    removeSourceColumn String
    removeSpecialCharacters String
    rightColumns String
    sampleSize String
    sampleType String
    secondInput String
    secondaryInputs List<Property Map>
    sheetIndexes List<Number>
    sheetNames List<String>
    sourceColumn String
    sourceColumn1 String
    sourceColumn2 String
    sourceColumns String
    startColumnIndex String
    startPattern String
    startPosition String
    startValue String
    stemmingMode String
    stepCount String
    stepIndex String
    stopWordsMode String
    strategy String
    targetColumn String
    targetColumnNames String
    targetDateFormat String
    targetIndex String
    timeZone String
    tokenizerPattern String
    trueString String
    udfLang String
    units String
    unpivotColumn String
    upperBound String
    useNewDataFrame String
    value String
    value1 String
    value2 String
    valueColumn String
    viewFrame String

    RecipeParametersInputProperties

    RecipeS3Location

    Bucket string
    Key string
    Bucket string
    Key string
    bucket String
    key String
    bucket string
    key string
    bucket str
    key str
    bucket String
    key String

    RecipeSecondaryInput

    RecipeStep

    Action RecipeAction
    ConditionExpressions []RecipeConditionExpression
    Condition expressions applied to the step action
    action RecipeAction
    conditionExpressions List<RecipeConditionExpression>
    Condition expressions applied to the step action
    action RecipeAction
    conditionExpressions RecipeConditionExpression[]
    Condition expressions applied to the step action
    action RecipeAction
    condition_expressions Sequence[RecipeConditionExpression]
    Condition expressions applied to the step action
    action Property Map
    conditionExpressions List<Property Map>
    Condition expressions applied to the step action

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi