AWS Native is in preview. AWS Classic is fully supported.
aws-native.databrew.Dataset
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource schema for AWS::DataBrew::Dataset.
Example Usage
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var testDataBrewDataset = new AwsNative.DataBrew.Dataset("testDataBrewDataset", new()
{
Name = "cf-test-dataset1",
Input = new AwsNative.DataBrew.Inputs.DatasetInputArgs
{
S3InputDefinition = new AwsNative.DataBrew.Inputs.DatasetS3LocationArgs
{
Bucket = "test-location",
Key = "test.xlsx",
},
},
FormatOptions = new AwsNative.DataBrew.Inputs.DatasetFormatOptionsArgs
{
Excel = new AwsNative.DataBrew.Inputs.DatasetExcelOptionsArgs
{
SheetNames = new[]
{
"test",
},
},
},
Tags = new[]
{
new AwsNative.DataBrew.Inputs.DatasetTagArgs
{
Key = "key00AtCreate",
Value = "value001AtCreate",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/databrew"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databrew.NewDataset(ctx, "testDataBrewDataset", &databrew.DatasetArgs{
Name: pulumi.String("cf-test-dataset1"),
Input: interface{}{
S3InputDefinition: &databrew.DatasetS3LocationArgs{
Bucket: pulumi.String("test-location"),
Key: pulumi.String("test.xlsx"),
},
},
FormatOptions: interface{}{
Excel: &databrew.DatasetExcelOptionsArgs{
SheetNames: pulumi.StringArray{
pulumi.String("test"),
},
},
},
Tags: []databrew.DatasetTagArgs{
{
Key: pulumi.String("key00AtCreate"),
Value: pulumi.String("value001AtCreate"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
test_data_brew_dataset = aws_native.databrew.Dataset("testDataBrewDataset",
name="cf-test-dataset1",
input=aws_native.databrew.DatasetInputArgs(
s3_input_definition=aws_native.databrew.DatasetS3LocationArgs(
bucket="test-location",
key="test.xlsx",
),
),
format_options=aws_native.databrew.DatasetFormatOptionsArgs(
excel=aws_native.databrew.DatasetExcelOptionsArgs(
sheet_names=["test"],
),
),
tags=[aws_native.databrew.DatasetTagArgs(
key="key00AtCreate",
value="value001AtCreate",
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const testDataBrewDataset = new aws_native.databrew.Dataset("testDataBrewDataset", {
name: "cf-test-dataset1",
input: {
s3InputDefinition: {
bucket: "test-location",
key: "test.xlsx",
},
},
formatOptions: {
excel: {
sheetNames: ["test"],
},
},
tags: [{
key: "key00AtCreate",
value: "value001AtCreate",
}],
});
Coming soon!
Create Dataset Resource
new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
@overload
def Dataset(resource_name: str,
opts: Optional[ResourceOptions] = None,
format: Optional[DatasetFormat] = None,
format_options: Optional[DatasetFormatOptionsArgs] = None,
input: Optional[DatasetInputArgs] = None,
name: Optional[str] = None,
path_options: Optional[DatasetPathOptionsArgs] = None,
tags: Optional[Sequence[DatasetTagArgs]] = None)
@overload
def Dataset(resource_name: str,
args: DatasetArgs,
opts: Optional[ResourceOptions] = None)
func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
type: aws-native:databrew:Dataset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Dataset Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Dataset resource accepts the following input properties:
- Input
Pulumi.
Aws Native. Data Brew. Inputs. Dataset Input Input
- Format
Pulumi.
Aws Native. Data Brew. Dataset Format Dataset format
- Format
Options Pulumi.Aws Native. Data Brew. Inputs. Dataset Format Options Format options for dataset
- Name string
Dataset name
- Path
Options Pulumi.Aws Native. Data Brew. Inputs. Dataset Path Options PathOptions
- List<Pulumi.
Aws Native. Data Brew. Inputs. Dataset Tag>
- Input
Dataset
Input Type Args Input
- Format
Dataset
Format Dataset format
- Format
Options DatasetFormat Options Args Format options for dataset
- Name string
Dataset name
- Path
Options DatasetPath Options Args PathOptions
- []Dataset
Tag Args
- input
Dataset
Input Input
- format
Dataset
Format Dataset format
- format
Options DatasetFormat Options Format options for dataset
- name String
Dataset name
- path
Options DatasetPath Options PathOptions
- List<Dataset
Tag>
- input
Dataset
Input Input
- format
Dataset
Format Dataset format
- format
Options DatasetFormat Options Format options for dataset
- name string
Dataset name
- path
Options DatasetPath Options PathOptions
- Dataset
Tag[]
- input
Dataset
Input Args Input
- format
Dataset
Format Dataset format
- format_
options DatasetFormat Options Args Format options for dataset
- name str
Dataset name
- path_
options DatasetPath Options Args PathOptions
- Sequence[Dataset
Tag Args]
- input Property Map
Input
- format "CSV" | "JSON" | "PARQUET" | "EXCEL" | "ORC"
Dataset format
- format
Options Property Map Format options for dataset
- name String
Dataset name
- path
Options Property Map PathOptions
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
DatasetCsvOptions, DatasetCsvOptionsArgs
- delimiter str
- header_
row bool
DatasetDataCatalogInputDefinition, DatasetDataCatalogInputDefinitionArgs
- 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, DatasetDatabaseInputDefinitionArgs
- 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, DatasetDatetimeOptionsArgs
- 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, DatasetExcelOptionsArgs
- 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, DatasetFilesLimitArgs
- 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, DatasetFilesLimitOrderArgs
- Ascending
- ASCENDING
- Descending
- DESCENDING
- Dataset
Files Limit Order Ascending - ASCENDING
- Dataset
Files Limit Order Descending - DESCENDING
- Ascending
- ASCENDING
- Descending
- DESCENDING
- Ascending
- ASCENDING
- Descending
- DESCENDING
- ASCENDING
- ASCENDING
- DESCENDING
- DESCENDING
- "ASCENDING"
- ASCENDING
- "DESCENDING"
- DESCENDING
DatasetFilesLimitOrderedBy, DatasetFilesLimitOrderedByArgs
- Last
Modified Date - LAST_MODIFIED_DATE
- Dataset
Files Limit Ordered By Last Modified Date - LAST_MODIFIED_DATE
- Last
Modified Date - LAST_MODIFIED_DATE
- Last
Modified Date - LAST_MODIFIED_DATE
- LAST_MODIFIED_DATE
- LAST_MODIFIED_DATE
- "LAST_MODIFIED_DATE"
- LAST_MODIFIED_DATE
DatasetFilterExpression, DatasetFilterExpressionArgs
- 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, DatasetFilterValueArgs
- 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, DatasetFormatArgs
- Csv
- CSV
- Json
- JSON
- Parquet
- PARQUET
- Excel
- EXCEL
- Orc
- ORC
- Dataset
Format Csv - CSV
- Dataset
Format Json - JSON
- Dataset
Format Parquet - PARQUET
- Dataset
Format Excel - EXCEL
- Dataset
Format Orc - ORC
- Csv
- CSV
- Json
- JSON
- Parquet
- PARQUET
- Excel
- EXCEL
- Orc
- ORC
- Csv
- CSV
- Json
- JSON
- Parquet
- PARQUET
- Excel
- EXCEL
- Orc
- ORC
- CSV
- CSV
- JSON
- JSON
- PARQUET
- PARQUET
- EXCEL
- EXCEL
- ORC
- ORC
- "CSV"
- CSV
- "JSON"
- JSON
- "PARQUET"
- PARQUET
- "EXCEL"
- EXCEL
- "ORC"
- ORC
DatasetFormatOptions, DatasetFormatOptionsArgs
DatasetInput, DatasetInputArgs
- 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, DatasetJsonOptionsArgs
- Multi
Line bool
- Multi
Line bool
- multi
Line Boolean
- multi
Line boolean
- multi_
line bool
- multi
Line Boolean
DatasetMetadata, DatasetMetadataArgs
- 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, DatasetParameterArgs
- 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, DatasetParameterTypeArgs
- String
- String
- Number
- Number
- Datetime
- Datetime
- Dataset
Parameter Type String - String
- Dataset
Parameter Type Number - Number
- Dataset
Parameter Type Datetime - Datetime
- String
- String
- Number
- Number
- Datetime
- Datetime
- String
- String
- Number
- Number
- Datetime
- Datetime
- STRING
- String
- NUMBER
- Number
- DATETIME
- Datetime
- "String"
- String
- "Number"
- Number
- "Datetime"
- Datetime
DatasetPathOptions, DatasetPathOptionsArgs
DatasetPathParameter, DatasetPathParameterArgs
DatasetS3Location, DatasetS3LocationArgs
DatasetTag, DatasetTagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.