We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.1.0 published on Friday, Oct 11, 2024 by Pulumi
aws-native.databrew.getDataset
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.1.0 published on Friday, Oct 11, 2024 by Pulumi
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
- A single character that specifies the delimiter being used in the CSV file.
- header_
row bool - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- Catalog
Id string - Catalog id
- Database
Name string - Database name
- Table
Name string - Table name
- Temp
Directory DatasetS3Location - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- catalog
Id String - Catalog id
- database
Name String - Database name
- table
Name String - Table name
- temp
Directory DatasetS3Location - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- catalog
Id string - Catalog id
- database
Name string - Database name
- table
Name string - Table name
- temp
Directory DatasetS3Location - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- catalog_
id str - Catalog id
- database_
name str - Database name
- table_
name str - Table name
- temp_
directory DatasetS3Location - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- catalog
Id String - Catalog id
- database
Name String - Database name
- table
Name String - Table name
- temp
Directory Property Map - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- 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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- 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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- 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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- 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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
- 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 - An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
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 - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- Sheet
Indexes List<int> - One or more sheet numbers in the Excel file that will be included in the dataset.
- Sheet
Names List<string> - One or more named sheets in the Excel file that will be included in the dataset.
- Header
Row bool - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- Sheet
Indexes []int - One or more sheet numbers in the Excel file that will be included in the dataset.
- Sheet
Names []string - One or more named sheets in the Excel file that will be included in the dataset.
- header
Row Boolean - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- sheet
Indexes List<Integer> - One or more sheet numbers in the Excel file that will be included in the dataset.
- sheet
Names List<String> - One or more named sheets in the Excel file that will be included in the dataset.
- header
Row boolean - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- sheet
Indexes number[] - One or more sheet numbers in the Excel file that will be included in the dataset.
- sheet
Names string[] - One or more named sheets in the Excel file that will be included in the dataset.
- header_
row bool - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- sheet_
indexes Sequence[int] - One or more sheet numbers in the Excel file that will be included in the dataset.
- sheet_
names Sequence[str] - One or more named sheets in the Excel file that will be included in the dataset.
- header
Row Boolean - A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
- sheet
Indexes List<Number> - One or more sheet numbers in the Excel file that will be included in the dataset.
- sheet
Names List<String> - One or more named sheets in the Excel file that will be included in the dataset.
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> - The map of substitution variable names to their values used in this filter expression.
- Expression string
- Filtering expression for a parameter
- Values
Map []DatasetFilter Value - The map of substitution variable names to their values used in this filter expression.
- expression String
- Filtering expression for a parameter
- values
Map List<DatasetFilter Value> - The map of substitution variable names to their values used in this filter expression.
- expression string
- Filtering expression for a parameter
- values
Map DatasetFilter Value[] - The map of substitution variable names to their values used in this filter expression.
- expression str
- Filtering expression for a parameter
- values_
map Sequence[DatasetFilter Value] - The map of substitution variable names to their values used in this filter expression.
- expression String
- Filtering expression for a parameter
- values
Map List<Property Map> - The map of substitution variable names to their values used in this filter expression.
DatasetFilterValue
- Value string
- The value to be associated with the substitution variable.
- Value
Reference string - Variable name
- Value string
- The value to be associated with the substitution variable.
- Value
Reference string - Variable name
- value String
- The value to be associated with the substitution variable.
- value
Reference String - Variable name
- value string
- The value to be associated with the substitution variable.
- value
Reference string - Variable name
- value str
- The value to be associated with the substitution variable.
- value_
reference str - Variable name
- value String
- The value to be associated with the substitution variable.
- value
Reference String - Variable name
DatasetFormat
DatasetFormatOptions
- Csv
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Csv Options - Options that define how CSV input is to be interpreted by DataBrew.
- Excel
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Excel Options - Options that define how Excel input is to be interpreted by DataBrew.
- Json
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Json Options - Options that define how JSON input is to be interpreted by DataBrew.
- Csv
Dataset
Csv Options - Options that define how CSV input is to be interpreted by DataBrew.
- Excel
Dataset
Excel Options - Options that define how Excel input is to be interpreted by DataBrew.
- Json
Dataset
Json Options - Options that define how JSON input is to be interpreted by DataBrew.
- csv
Dataset
Csv Options - Options that define how CSV input is to be interpreted by DataBrew.
- excel
Dataset
Excel Options - Options that define how Excel input is to be interpreted by DataBrew.
- json
Dataset
Json Options - Options that define how JSON input is to be interpreted by DataBrew.
- csv
Dataset
Csv Options - Options that define how CSV input is to be interpreted by DataBrew.
- excel
Dataset
Excel Options - Options that define how Excel input is to be interpreted by DataBrew.
- json
Dataset
Json Options - Options that define how JSON input is to be interpreted by DataBrew.
- csv
Dataset
Csv Options - Options that define how CSV input is to be interpreted by DataBrew.
- excel
Dataset
Excel Options - Options that define how Excel input is to be interpreted by DataBrew.
- json
Dataset
Json Options - Options that define how JSON input is to be interpreted by DataBrew.
- csv Property Map
- Options that define how CSV input is to be interpreted by DataBrew.
- excel Property Map
- Options that define how Excel input is to be interpreted by DataBrew.
- json Property Map
- Options that define how JSON input is to be interpreted by DataBrew.
DatasetInput
- Data
Catalog Pulumi.Input Definition Aws Native. Data Brew. Inputs. Dataset Data Catalog Input Definition - The AWS Glue Data Catalog parameters for the data.
- Database
Input Pulumi.Definition Aws Native. Data Brew. Inputs. Dataset Database Input Definition - Connection information for dataset input files stored in a database.
- Metadata
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Metadata - Contains additional resource information needed for specific datasets.
- S3Input
Definition Pulumi.Aws Native. Data Brew. Inputs. Dataset S3Location - The Amazon S3 location where the data is stored.
- Data
Catalog DatasetInput Definition Data Catalog Input Definition - The AWS Glue Data Catalog parameters for the data.
- Database
Input DatasetDefinition Database Input Definition - Connection information for dataset input files stored in a database.
- Metadata
Dataset
Metadata - Contains additional resource information needed for specific datasets.
- S3Input
Definition DatasetS3Location - The Amazon S3 location where the data is stored.
- data
Catalog DatasetInput Definition Data Catalog Input Definition - The AWS Glue Data Catalog parameters for the data.
- database
Input DatasetDefinition Database Input Definition - Connection information for dataset input files stored in a database.
- metadata
Dataset
Metadata - Contains additional resource information needed for specific datasets.
- s3Input
Definition DatasetS3Location - The Amazon S3 location where the data is stored.
- data
Catalog DatasetInput Definition Data Catalog Input Definition - The AWS Glue Data Catalog parameters for the data.
- database
Input DatasetDefinition Database Input Definition - Connection information for dataset input files stored in a database.
- metadata
Dataset
Metadata - Contains additional resource information needed for specific datasets.
- s3Input
Definition DatasetS3Location - The Amazon S3 location where the data is stored.
- data_
catalog_ Datasetinput_ definition Data Catalog Input Definition - The AWS Glue Data Catalog parameters for the data.
- database_
input_ Datasetdefinition Database Input Definition - Connection information for dataset input files stored in a database.
- metadata
Dataset
Metadata - Contains additional resource information needed for specific datasets.
- s3_
input_ Datasetdefinition S3Location - The Amazon S3 location where the data is stored.
- data
Catalog Property MapInput Definition - The AWS Glue Data Catalog parameters for the data.
- database
Input Property MapDefinition - Connection information for dataset input files stored in a database.
- metadata Property Map
- Contains additional resource information needed for specific datasets.
- s3Input
Definition Property Map - The Amazon S3 location where the data is stored.
DatasetJsonOptions
- Multi
Line bool - A value that specifies whether JSON input contains embedded new line characters.
- Multi
Line bool - A value that specifies whether JSON input contains embedded new line characters.
- multi
Line Boolean - A value that specifies whether JSON input contains embedded new line characters.
- multi
Line boolean - A value that specifies whether JSON input contains embedded new line characters.
- multi_
line bool - A value that specifies whether JSON input contains embedded new line characters.
- multi
Line Boolean - A value that specifies whether JSON input contains embedded new line characters.
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
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- Filter
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Filter Expression - The optional filter expression structure to apply additional matching criteria to the parameter.
- Name string
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- Filter
Dataset
Filter Expression - The optional filter expression structure to apply additional matching criteria to the parameter.
- name String
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- filter
Dataset
Filter Expression - The optional filter expression structure to apply additional matching criteria to the parameter.
- name string
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- filter
Dataset
Filter Expression - The optional filter expression structure to apply additional matching criteria to the parameter.
- name str
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- filter
Dataset
Filter Expression - The optional filter expression structure to apply additional matching criteria to the parameter.
- name String
- The name of the parameter that is used in the dataset's Amazon S3 path.
- 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 - Additional parameter options such as a format and a timezone. Required for datetime parameters.
- filter Property Map
- The optional filter expression structure to apply additional matching criteria to the parameter.
DatasetParameterType
DatasetPathOptions
- Files
Limit Pulumi.Aws Native. Data Brew. Inputs. Dataset Files Limit - If provided, this structure imposes a limit on a number of files that should be selected.
- Last
Modified Pulumi.Date Condition Aws Native. Data Brew. Inputs. Dataset Filter Expression - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- Parameters
List<Pulumi.
Aws Native. Data Brew. Inputs. Dataset Path Parameter> - A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
- Files
Limit DatasetFiles Limit - If provided, this structure imposes a limit on a number of files that should be selected.
- Last
Modified DatasetDate Condition Filter Expression - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- Parameters
[]Dataset
Path Parameter - A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
- files
Limit DatasetFiles Limit - If provided, this structure imposes a limit on a number of files that should be selected.
- last
Modified DatasetDate Condition Filter Expression - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- parameters
List<Dataset
Path Parameter> - A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
- files
Limit DatasetFiles Limit - If provided, this structure imposes a limit on a number of files that should be selected.
- last
Modified DatasetDate Condition Filter Expression - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- parameters
Dataset
Path Parameter[] - A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
- files_
limit DatasetFiles Limit - If provided, this structure imposes a limit on a number of files that should be selected.
- last_
modified_ Datasetdate_ condition Filter Expression - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- parameters
Sequence[Dataset
Path Parameter] - A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
- files
Limit Property Map - If provided, this structure imposes a limit on a number of files that should be selected.
- last
Modified Property MapDate Condition - If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
- parameters List<Property Map>
- A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
DatasetPathParameter
- Dataset
Parameter Pulumi.Aws Native. Data Brew. Inputs. Dataset Parameter - The path parameter definition.
- Path
Parameter stringName - The name of the path parameter.
- Dataset
Parameter DatasetParameter - The path parameter definition.
- Path
Parameter stringName - The name of the path parameter.
- dataset
Parameter DatasetParameter - The path parameter definition.
- path
Parameter StringName - The name of the path parameter.
- dataset
Parameter DatasetParameter - The path parameter definition.
- path
Parameter stringName - The name of the path parameter.
- dataset_
parameter DatasetParameter - The path parameter definition.
- path_
parameter_ strname - The name of the path parameter.
- dataset
Parameter Property Map - The path parameter definition.
- path
Parameter StringName - The name of the path parameter.
DatasetS3Location
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.1.0 published on Friday, Oct 11, 2024 by Pulumi