Docs Home
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
aws-native.databrew.getRecipe
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 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)
public static Output<GetRecipeResult> getRecipe(GetRecipeArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:databrew:getRecipe
arguments:
# arguments dictionaryThe 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
List<Pulumi.
Aws Native. Data Brew. Outputs. Recipe Step> - A list of steps that are defined by the recipe.
- Description string
- Description of the recipe
- Steps
[]Recipe
Step - A list of steps that are defined by the recipe.
- description String
- Description of the recipe
- steps
List<Recipe
Step> - A list of steps that are defined by the recipe.
- description string
- Description of the recipe
- steps
Recipe
Step[] - A list of steps that are defined by the recipe.
- description str
- Description of the recipe
- steps
Sequence[Recipe
Step] - A list of steps that are defined by the recipe.
- description String
- Description of the recipe
- steps List<Property Map>
- A list of steps that are defined by the recipe.
Supporting Types
RecipeAction
- Operation string
- Step action operation
- Parameters
Pulumi.
Aws | Dictionary<string, string>Native. Data Brew. Inputs. Recipe Parameters - Contextual parameters for the transformation.
- Operation string
- Step action operation
- Parameters
Recipe
Parameters | map[string]string - Contextual parameters for the transformation.
- operation String
- Step action operation
- parameters
Recipe
Parameters | Map<String,String> - Contextual parameters for the transformation.
- operation string
- Step action operation
- parameters
Recipe
Parameters | {[key: string]: string} - Contextual parameters for the transformation.
- operation str
- Step action operation
- parameters
Recipe
Parameters | Mapping[str, str] - Contextual parameters for the transformation.
- operation String
- Step action operation
- parameters Property Map | Map<String>
- Contextual parameters for the transformation.
RecipeConditionExpression
- Condition string
- Input condition to be applied to the target column
- Target
Column string - Name of the target column
- Value string
- Value of the condition
- Condition string
- Input condition to be applied to the target column
- Target
Column string - Name of the target column
- Value string
- Value of the condition
- condition String
- Input condition to be applied to the target column
- target
Column String - Name of the target column
- value String
- Value of the condition
- condition string
- Input condition to be applied to the target column
- target
Column 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
- target
Column String - Name of the target column
- value String
- Value of the condition
RecipeDataCatalogInputDefinition
- Catalog
Id string - Catalog id
- Database
Name string - Database name
- Table
Name string - Table name
- Temp
Directory Pulumi.Aws Native. Data Brew. Inputs. Recipe S3Location
- Catalog
Id string - Catalog id
- Database
Name string - Database name
- Table
Name string - Table name
- Temp
Directory RecipeS3Location
- catalog
Id String - Catalog id
- database
Name String - Database name
- table
Name String - Table name
- temp
Directory RecipeS3Location
- catalog
Id string - Catalog id
- database
Name string - Database name
- table
Name string - Table name
- temp
Directory RecipeS3Location
- catalog_
id str - Catalog id
- database_
name str - Database name
- table_
name str - Table name
- temp_
directory RecipeS3Location
- catalog
Id String - Catalog id
- database
Name String - Database name
- table
Name String - Table name
- temp
Directory Property Map
RecipeParameters
- Aggregate
Function string - Base string
- Case
Statement string - Category
Map string - Chars
To stringRemove - Collapse
Consecutive stringWhitespace - Column
Data stringType - Column
Range string - Count string
- Custom
Characters string - Custom
Stop stringWords - Custom
Value string - Datasets
Columns string - Date
Add stringValue - Date
Time stringFormat - Date
Time stringParameters - Delete
Other stringRows - Delimiter string
- End
Pattern string - End
Position string - End
Value string - Expand
Contractions string - Exponent string
- False
String string - Group
By stringAgg Function Options - Group
By stringColumns - string
- Ignore
Case string - Include
In stringSplit - Input
Pulumi.
Aws Native. Data Brew. Inputs. Recipe Parameters Input Properties - Input
- Interval string
- Is
Text string - Join
Keys string - Join
Type string - Left
Columns string - Limit string
- Lower
Bound string - Map
Type string - Mode
Type string - Multi
Line bool - Num
Rows string - Num
Rows stringAfter - Num
Rows stringBefore - Order
By stringColumn - Order
By stringColumns - Other string
- Pattern string
- Pattern
Option1 string - Pattern
Option2 string - Pattern
Options string - Period string
- Position string
- Remove
All stringPunctuation - Remove
All stringQuotes - Remove
All stringWhitespace - Remove
Custom stringCharacters - Remove
Custom stringValue - Remove
Leading stringAnd Trailing Punctuation - Remove
Leading stringAnd Trailing Quotes - Remove
Leading stringAnd Trailing Whitespace - Remove
Letters string - Remove
Numbers string - Remove
Source stringColumn - Remove
Special stringCharacters - Right
Columns string - Sample
Size string - Sample
Type string - Second
Input string - Secondary
Inputs List<Pulumi.Aws Native. Data Brew. Inputs. Recipe Secondary Input> - Sheet
Indexes List<int> - Sheet
Names List<string> - Source
Column string - Source
Column1 string - Source
Column2 string - Source
Columns string - Start
Column stringIndex - Start
Pattern string - Start
Position string - Start
Value string - Stemming
Mode string - Step
Count string - Step
Index string - Stop
Words stringMode - Strategy string
- Target
Column string - Target
Column stringNames - Target
Date stringFormat - Target
Index string - Time
Zone string - Tokenizer
Pattern string - True
String string - Udf
Lang string - Units string
- Unpivot
Column string - Upper
Bound string - Use
New stringData Frame - Value string
- Value1 string
- Value2 string
- Value
Column string - View
Frame string
- Aggregate
Function string - Base string
- Case
Statement string - Category
Map string - Chars
To stringRemove - Collapse
Consecutive stringWhitespace - Column
Data stringType - Column
Range string - Count string
- Custom
Characters string - Custom
Stop stringWords - Custom
Value string - Datasets
Columns string - Date
Add stringValue - Date
Time stringFormat - Date
Time stringParameters - Delete
Other stringRows - Delimiter string
- End
Pattern string - End
Position string - End
Value string - Expand
Contractions string - Exponent string
- False
String string - Group
By stringAgg Function Options - Group
By stringColumns - string
- Ignore
Case string - Include
In stringSplit - Input
Recipe
Parameters Input Properties - Input
- Interval string
- Is
Text string - Join
Keys string - Join
Type string - Left
Columns string - Limit string
- Lower
Bound string - Map
Type string - Mode
Type string - Multi
Line bool - Num
Rows string - Num
Rows stringAfter - Num
Rows stringBefore - Order
By stringColumn - Order
By stringColumns - Other string
- Pattern string
- Pattern
Option1 string - Pattern
Option2 string - Pattern
Options string - Period string
- Position string
- Remove
All stringPunctuation - Remove
All stringQuotes - Remove
All stringWhitespace - Remove
Custom stringCharacters - Remove
Custom stringValue - Remove
Leading stringAnd Trailing Punctuation - Remove
Leading stringAnd Trailing Quotes - Remove
Leading stringAnd Trailing Whitespace - Remove
Letters string - Remove
Numbers string - Remove
Source stringColumn - Remove
Special stringCharacters - Right
Columns string - Sample
Size string - Sample
Type string - Second
Input string - Secondary
Inputs []RecipeSecondary Input - Sheet
Indexes []int - Sheet
Names []string - Source
Column string - Source
Column1 string - Source
Column2 string - Source
Columns string - Start
Column stringIndex - Start
Pattern string - Start
Position string - Start
Value string - Stemming
Mode string - Step
Count string - Step
Index string - Stop
Words stringMode - Strategy string
- Target
Column string - Target
Column stringNames - Target
Date stringFormat - Target
Index string - Time
Zone string - Tokenizer
Pattern string - True
String string - Udf
Lang string - Units string
- Unpivot
Column string - Upper
Bound string - Use
New stringData Frame - Value string
- Value1 string
- Value2 string
- Value
Column string - View
Frame string
- aggregate
Function String - base String
- case
Statement String - category
Map String - chars
To StringRemove - collapse
Consecutive StringWhitespace - column
Data StringType - column
Range String - count String
- custom
Characters String - custom
Stop StringWords - custom
Value String - datasets
Columns String - date
Add StringValue - date
Time StringFormat - date
Time StringParameters - delete
Other StringRows - delimiter String
- end
Pattern String - end
Position String - end
Value String - expand
Contractions String - exponent String
- false
String String - group
By StringAgg Function Options - group
By StringColumns - String
- ignore
Case String - include
In StringSplit - input
Recipe
Parameters Input Properties - Input
- interval String
- is
Text String - join
Keys String - join
Type String - left
Columns String - limit String
- lower
Bound String - map
Type String - mode
Type String - multi
Line Boolean - num
Rows String - num
Rows StringAfter - num
Rows StringBefore - order
By StringColumn - order
By StringColumns - other String
- pattern String
- pattern
Option1 String - pattern
Option2 String - pattern
Options String - period String
- position String
- remove
All StringPunctuation - remove
All StringQuotes - remove
All StringWhitespace - remove
Custom StringCharacters - remove
Custom StringValue - remove
Leading StringAnd Trailing Punctuation - remove
Leading StringAnd Trailing Quotes - remove
Leading StringAnd Trailing Whitespace - remove
Letters String - remove
Numbers String - remove
Source StringColumn - remove
Special StringCharacters - right
Columns String - sample
Size String - sample
Type String - second
Input String - secondary
Inputs List<RecipeSecondary Input> - sheet
Indexes List<Integer> - sheet
Names List<String> - source
Column String - source
Column1 String - source
Column2 String - source
Columns String - start
Column StringIndex - start
Pattern String - start
Position String - start
Value String - stemming
Mode String - step
Count String - step
Index String - stop
Words StringMode - strategy String
- target
Column String - target
Column StringNames - target
Date StringFormat - target
Index String - time
Zone String - tokenizer
Pattern String - true
String String - udf
Lang String - units String
- unpivot
Column String - upper
Bound String - use
New StringData Frame - value String
- value1 String
- value2 String
- value
Column String - view
Frame String
- aggregate
Function string - base string
- case
Statement string - category
Map string - chars
To stringRemove - collapse
Consecutive stringWhitespace - column
Data stringType - column
Range string - count string
- custom
Characters string - custom
Stop stringWords - custom
Value string - datasets
Columns string - date
Add stringValue - date
Time stringFormat - date
Time stringParameters - delete
Other stringRows - delimiter string
- end
Pattern string - end
Position string - end
Value string - expand
Contractions string - exponent string
- false
String string - group
By stringAgg Function Options - group
By stringColumns - string
- ignore
Case string - include
In stringSplit - input
Recipe
Parameters Input Properties - Input
- interval string
- is
Text string - join
Keys string - join
Type string - left
Columns string - limit string
- lower
Bound string - map
Type string - mode
Type string - multi
Line boolean - num
Rows string - num
Rows stringAfter - num
Rows stringBefore - order
By stringColumn - order
By stringColumns - other string
- pattern string
- pattern
Option1 string - pattern
Option2 string - pattern
Options string - period string
- position string
- remove
All stringPunctuation - remove
All stringQuotes - remove
All stringWhitespace - remove
Custom stringCharacters - remove
Custom stringValue - remove
Leading stringAnd Trailing Punctuation - remove
Leading stringAnd Trailing Quotes - remove
Leading stringAnd Trailing Whitespace - remove
Letters string - remove
Numbers string - remove
Source stringColumn - remove
Special stringCharacters - right
Columns string - sample
Size string - sample
Type string - second
Input string - secondary
Inputs RecipeSecondary Input[] - sheet
Indexes number[] - sheet
Names string[] - source
Column string - source
Column1 string - source
Column2 string - source
Columns string - start
Column stringIndex - start
Pattern string - start
Position string - start
Value string - stemming
Mode string - step
Count string - step
Index string - stop
Words stringMode - strategy string
- target
Column string - target
Column stringNames - target
Date stringFormat - target
Index string - time
Zone string - tokenizer
Pattern string - true
String string - udf
Lang string - units string
- unpivot
Column string - upper
Bound string - use
New stringData Frame - value string
- value1 string
- value2 string
- value
Column string - view
Frame string
- aggregate_
function str - base str
- case_
statement str - category_
map str - chars_
to_ strremove - collapse_
consecutive_ strwhitespace - column_
data_ strtype - column_
range str - count str
- custom_
characters str - custom_
stop_ strwords - custom_
value str - datasets_
columns str - date_
add_ strvalue - date_
time_ strformat - date_
time_ strparameters - delete_
other_ strrows - delimiter str
- end_
pattern str - end_
position str - end_
value str - expand_
contractions str - exponent str
- false_
string str - group_
by_ stragg_ function_ options - group_
by_ strcolumns - str
- ignore_
case str - include_
in_ strsplit - input
Recipe
Parameters Input Properties - 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_ strafter - num_
rows_ strbefore - order_
by_ strcolumn - order_
by_ strcolumns - other str
- pattern str
- pattern_
option1 str - pattern_
option2 str - pattern_
options str - period str
- position str
- remove_
all_ strpunctuation - remove_
all_ strquotes - remove_
all_ strwhitespace - remove_
custom_ strcharacters - remove_
custom_ strvalue - remove_
leading_ strand_ trailing_ punctuation - remove_
leading_ strand_ trailing_ quotes - remove_
leading_ strand_ trailing_ whitespace - remove_
letters str - remove_
numbers str - remove_
source_ strcolumn - remove_
special_ strcharacters - right_
columns str - sample_
size str - sample_
type str - second_
input str - secondary_
inputs Sequence[RecipeSecondary Input] - sheet_
indexes Sequence[int] - sheet_
names Sequence[str] - source_
column str - source_
column1 str - source_
column2 str - source_
columns str - start_
column_ strindex - start_
pattern str - start_
position str - start_
value str - stemming_
mode str - step_
count str - step_
index str - stop_
words_ strmode - strategy str
- target_
column str - target_
column_ strnames - target_
date_ strformat - 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_ strdata_ frame - value str
- value1 str
- value2 str
- value_
column str - view_
frame str
- aggregate
Function String - base String
- case
Statement String - category
Map String - chars
To StringRemove - collapse
Consecutive StringWhitespace - column
Data StringType - column
Range String - count String
- custom
Characters String - custom
Stop StringWords - custom
Value String - datasets
Columns String - date
Add StringValue - date
Time StringFormat - date
Time StringParameters - delete
Other StringRows - delimiter String
- end
Pattern String - end
Position String - end
Value String - expand
Contractions String - exponent String
- false
String String - group
By StringAgg Function Options - group
By StringColumns - String
- ignore
Case String - include
In StringSplit - input Property Map
- Input
- interval String
- is
Text String - join
Keys String - join
Type String - left
Columns String - limit String
- lower
Bound String - map
Type String - mode
Type String - multi
Line Boolean - num
Rows String - num
Rows StringAfter - num
Rows StringBefore - order
By StringColumn - order
By StringColumns - other String
- pattern String
- pattern
Option1 String - pattern
Option2 String - pattern
Options String - period String
- position String
- remove
All StringPunctuation - remove
All StringQuotes - remove
All StringWhitespace - remove
Custom StringCharacters - remove
Custom StringValue - remove
Leading StringAnd Trailing Punctuation - remove
Leading StringAnd Trailing Quotes - remove
Leading StringAnd Trailing Whitespace - remove
Letters String - remove
Numbers String - remove
Source StringColumn - remove
Special StringCharacters - right
Columns String - sample
Size String - sample
Type String - second
Input String - secondary
Inputs List<Property Map> - sheet
Indexes List<Number> - sheet
Names List<String> - source
Column String - source
Column1 String - source
Column2 String - source
Columns String - start
Column StringIndex - start
Pattern String - start
Position String - start
Value String - stemming
Mode String - step
Count String - step
Index String - stop
Words StringMode - strategy String
- target
Column String - target
Column StringNames - target
Date StringFormat - target
Index String - time
Zone String - tokenizer
Pattern String - true
String String - udf
Lang String - units String
- unpivot
Column String - upper
Bound String - use
New StringData Frame - value String
- value1 String
- value2 String
- value
Column String - view
Frame String
RecipeParametersInputProperties
RecipeS3Location
RecipeSecondaryInput
RecipeStep
- Action
Pulumi.
Aws Native. Data Brew. Inputs. Recipe Action - The particular action to be performed in the recipe step.
- Condition
Expressions List<Pulumi.Aws Native. Data Brew. Inputs. Recipe Condition Expression> - Condition expressions applied to the step action
- Action
Recipe
Action - The particular action to be performed in the recipe step.
- Condition
Expressions []RecipeCondition Expression - Condition expressions applied to the step action
- action
Recipe
Action - The particular action to be performed in the recipe step.
- condition
Expressions List<RecipeCondition Expression> - Condition expressions applied to the step action
- action
Recipe
Action - The particular action to be performed in the recipe step.
- condition
Expressions RecipeCondition Expression[] - Condition expressions applied to the step action
- action
Recipe
Action - The particular action to be performed in the recipe step.
- condition_
expressions Sequence[RecipeCondition Expression] - Condition expressions applied to the step action
- action Property Map
- The particular action to be performed in the recipe step.
- condition
Expressions List<Property Map> - Condition expressions applied to the step action
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi