AWS Native
getDataset
Resource schema for AWS::DataBrew::Dataset.
Using getDataset
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 getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
def get_dataset(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput
> Note: This function is named LookupDataset
in the Go SDK.
public static class GetDataset
{
public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws-native:databrew:getDataset
Arguments:
# Arguments dictionary
The following arguments are supported:
- Name string
Dataset name
- Name string
Dataset name
- name String
Dataset name
- name string
Dataset name
- name str
Dataset name
- name String
Dataset name
getDataset Result
The following output properties are available:
- Format
Pulumi.
Aws Native. Data Brew. Dataset Format Dataset format
- Format
Options Pulumi.Aws Native. Data Brew. Outputs. Dataset Format Options Format options for dataset
- Input
Pulumi.
Aws Native. Data Brew. Outputs. Dataset Input Input
- Path
Options Pulumi.Aws Native. Data Brew. Outputs. Dataset Path Options PathOptions
- Format
Dataset
Format Dataset format
- Format
Options DatasetFormat Options Format options for dataset
- Input
Dataset
Input Type Input
- Path
Options DatasetPath Options PathOptions
- format
Dataset
Format Dataset format
- format
Options DatasetFormat Options Format options for dataset
- input
Dataset
Input Input
- path
Options DatasetPath Options PathOptions
- format
Dataset
Format Dataset format
- format
Options DatasetFormat Options Format options for dataset
- input
Dataset
Input Input
- path
Options DatasetPath Options PathOptions
- format
Dataset
Format Dataset format
- format_
options DatasetFormat Options Format options for dataset
- input
Dataset
Input Input
- path_
options DatasetPath Options PathOptions
- format "CSV" | "JSON" | "PARQUET" | "EXCEL" | "ORC"
Dataset format
- format
Options Property Map Format options for dataset
- input Property Map
Input
- path
Options Property Map PathOptions
Supporting Types
DatasetCsvOptions
- delimiter str
- header_
row bool
DatasetDataCatalogInputDefinition
- Catalog
Id string Catalog id
- Database
Name string Database name
- Table
Name string Table name
- Temp
Directory Pulumi.Aws Native. Data Brew. Inputs. Dataset S3Location
- Catalog
Id string Catalog id
- Database
Name string Database name
- Table
Name string Table name
- Temp
Directory DatasetS3Location
- catalog
Id String Catalog id
- database
Name String Database name
- table
Name String Table name
- temp
Directory DatasetS3Location
- catalog
Id string Catalog id
- database
Name string Database name
- table
Name string Table name
- temp
Directory DatasetS3Location
- catalog_
id str Catalog id
- database_
name str Database name
- table_
name str Table name
- temp_
directory DatasetS3Location
- catalog
Id String Catalog id
- database
Name String Database name
- table
Name String Table name
- temp
Directory Property Map
DatasetDatabaseInputDefinition
- Glue
Connection stringName Glue connection name
- Database
Table stringName Database table name
- Query
String string Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- Temp
Directory Pulumi.Aws Native. Data Brew. Inputs. Dataset S3Location
- Glue
Connection stringName Glue connection name
- Database
Table stringName Database table name
- Query
String string Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- Temp
Directory DatasetS3Location
- glue
Connection StringName Glue connection name
- database
Table StringName Database table name
- query
String String Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- temp
Directory DatasetS3Location
- glue
Connection stringName Glue connection name
- database
Table stringName Database table name
- query
String string Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- temp
Directory DatasetS3Location
- glue_
connection_ strname Glue connection name
- database_
table_ strname Database table name
- query_
string str Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- temp_
directory DatasetS3Location
- glue
Connection StringName Glue connection name
- database
Table StringName Database table name
- query
String String Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
- temp
Directory Property Map
DatasetDatetimeOptions
- Format string
Date/time format of a date parameter
- Locale
Code string Locale code for a date parameter
- Timezone
Offset string Timezone offset
- Format string
Date/time format of a date parameter
- Locale
Code string Locale code for a date parameter
- Timezone
Offset string Timezone offset
- format String
Date/time format of a date parameter
- locale
Code String Locale code for a date parameter
- timezone
Offset String Timezone offset
- format string
Date/time format of a date parameter
- locale
Code string Locale code for a date parameter
- timezone
Offset string Timezone offset
- format str
Date/time format of a date parameter
- locale_
code str Locale code for a date parameter
- timezone_
offset str Timezone offset
- format String
Date/time format of a date parameter
- locale
Code String Locale code for a date parameter
- timezone
Offset String Timezone offset
DatasetExcelOptions
- Header
Row bool - Sheet
Indexes List<int> - Sheet
Names List<string>
- Header
Row bool - Sheet
Indexes []int - Sheet
Names []string
- header
Row Boolean - sheet
Indexes List<Integer> - sheet
Names List<String>
- header
Row boolean - sheet
Indexes number[] - sheet
Names string[]
- header_
row bool - sheet_
indexes Sequence[int] - sheet_
names Sequence[str]
- header
Row Boolean - sheet
Indexes List<Number> - sheet
Names List<String>
DatasetFilesLimit
- Max
Files int Maximum number of files
- Order
Pulumi.
Aws Native. Data Brew. Dataset Files Limit Order Order
- Ordered
By Pulumi.Aws Native. Data Brew. Dataset Files Limit Ordered By Ordered by
- Max
Files int Maximum number of files
- Order
Dataset
Files Limit Order Order
- Ordered
By DatasetFiles Limit Ordered By Ordered by
- max
Files Integer Maximum number of files
- order
Dataset
Files Limit Order Order
- ordered
By DatasetFiles Limit Ordered By Ordered by
- max
Files number Maximum number of files
- order
Dataset
Files Limit Order Order
- ordered
By DatasetFiles Limit Ordered By Ordered by
- max_
files int Maximum number of files
- order
Dataset
Files Limit Order Order
- ordered_
by DatasetFiles Limit Ordered By Ordered by
- max
Files Number Maximum number of files
- order "ASCENDING" | "DESCENDING"
Order
- ordered
By "LAST_MODIFIED_DATE" Ordered by
DatasetFilesLimitOrder
DatasetFilesLimitOrderedBy
DatasetFilterExpression
- Expression string
Filtering expression for a parameter
- Values
Map List<Pulumi.Aws Native. Data Brew. Inputs. Dataset Filter Value>
- Expression string
Filtering expression for a parameter
- Values
Map []DatasetFilter Value
- expression String
Filtering expression for a parameter
- values
Map List<DatasetFilter Value>
- expression string
Filtering expression for a parameter
- values
Map DatasetFilter Value[]
- expression str
Filtering expression for a parameter
- values_
map Sequence[DatasetFilter Value]
- expression String
Filtering expression for a parameter
- values
Map List<Property Map>
DatasetFilterValue
- Value string
- Value
Reference string Variable name
- Value string
- Value
Reference string Variable name
- value String
- value
Reference String Variable name
- value string
- value
Reference string Variable name
- value str
- value_
reference str Variable name
- value String
- value
Reference String Variable name
DatasetFormat
DatasetFormatOptions
DatasetInput
- Data
Catalog Pulumi.Input Definition Aws Native. Data Brew. Inputs. Dataset Data Catalog Input Definition - Database
Input Pulumi.Definition Aws Native. Data Brew. Inputs. Dataset Database Input Definition - Metadata
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Metadata - S3Input
Definition Pulumi.Aws Native. Data Brew. Inputs. Dataset S3Location
DatasetJsonOptions
- Multi
Line bool
- Multi
Line bool
- multi
Line Boolean
- multi
Line boolean
- multi_
line bool
- multi
Line Boolean
DatasetMetadata
- Source
Arn string Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
- Source
Arn string Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
- source
Arn String Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
- source
Arn string Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
- source_
arn str Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
- source
Arn String Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.
DatasetParameter
- Name string
- Type
Pulumi.
Aws Native. Data Brew. Dataset Parameter Type Parameter type
- Create
Column bool Add the value of this parameter as a column in a dataset.
- Datetime
Options Pulumi.Aws Native. Data Brew. Inputs. Dataset Datetime Options - Filter
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Filter Expression
- Name string
- Type
Dataset
Parameter Type Parameter type
- Create
Column bool Add the value of this parameter as a column in a dataset.
- Datetime
Options DatasetDatetime Options - Filter
Dataset
Filter Expression
- name String
- type
Dataset
Parameter Type Parameter type
- create
Column Boolean Add the value of this parameter as a column in a dataset.
- datetime
Options DatasetDatetime Options - filter
Dataset
Filter Expression
- name string
- type
Dataset
Parameter Type Parameter type
- create
Column boolean Add the value of this parameter as a column in a dataset.
- datetime
Options DatasetDatetime Options - filter
Dataset
Filter Expression
- name str
- type
Dataset
Parameter Type Parameter type
- create_
column bool Add the value of this parameter as a column in a dataset.
- datetime_
options DatasetDatetime Options - filter
Dataset
Filter Expression
- name String
- type "String" | "Number" | "Datetime"
Parameter type
- create
Column Boolean Add the value of this parameter as a column in a dataset.
- datetime
Options Property Map - filter Property Map
DatasetParameterType
DatasetPathOptions
DatasetPathParameter
DatasetS3Location
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0