AWS Native v0.54.0, Mar 21 23

aws-native.databrew.Dataset

Resource schema for AWS::DataBrew::Dataset.

Example Usage

Example

using System.Collections.Generic;
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",
            },
        },
    });

});

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.AwsNative.DataBrew.Inputs.DatasetInputArgs: Input
Format Pulumi.AwsNative.DataBrew.DatasetFormat: Dataset format
FormatOptions Pulumi.AwsNative.DataBrew.Inputs.DatasetFormatOptionsArgs: Format options for dataset
Name string: Dataset name
PathOptions Pulumi.AwsNative.DataBrew.Inputs.DatasetPathOptionsArgs: PathOptions
Tags List<Pulumi.AwsNative.DataBrew.Inputs.DatasetTagArgs>

Input DatasetInputTypeArgs: Input
Format DatasetFormat: Dataset format
FormatOptions DatasetFormatOptionsArgs: Format options for dataset
Name string: Dataset name
PathOptions DatasetPathOptionsArgs: PathOptions
Tags []DatasetTagArgs

input DatasetInputArgs: Input
format DatasetFormat: Dataset format
formatOptions DatasetFormatOptionsArgs: Format options for dataset
name String: Dataset name
pathOptions DatasetPathOptionsArgs: PathOptions
tags List<DatasetTagArgs>

input DatasetInputArgs: Input
format DatasetFormat: Dataset format
formatOptions DatasetFormatOptionsArgs: Format options for dataset
name string: Dataset name
pathOptions DatasetPathOptionsArgs: PathOptions
tags DatasetTagArgs[]

input DatasetInputArgs: Input
format DatasetFormat: Dataset format
format_options DatasetFormatOptionsArgs: Format options for dataset
name str: Dataset name
path_options DatasetPathOptionsArgs: PathOptions
tags Sequence[DatasetTagArgs]

input Property Map: Input
format "CSV" | "JSON" | "PARQUET" | "EXCEL" | "ORC": Dataset format
formatOptions Property Map: Format options for dataset
name String: Dataset name
pathOptions Property Map: PathOptions
tags 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

Delimiter string
HeaderRow bool

Delimiter string
HeaderRow bool

delimiter String
headerRow Boolean

delimiter string
headerRow boolean

delimiter str
header_row bool

delimiter String
headerRow Boolean

DatasetDataCatalogInputDefinition

CatalogId string: Catalog id
DatabaseName string: Database name
TableName string: Table name
TempDirectory Pulumi.AwsNative.DataBrew.Inputs.DatasetS3Location

CatalogId string: Catalog id
DatabaseName string: Database name
TableName string: Table name
TempDirectory DatasetS3Location

catalogId String: Catalog id
databaseName String: Database name
tableName String: Table name
tempDirectory DatasetS3Location

catalogId string: Catalog id
databaseName string: Database name
tableName string: Table name
tempDirectory DatasetS3Location

catalog_id str: Catalog id
database_name str: Database name
table_name str: Table name
temp_directory DatasetS3Location

catalogId String: Catalog id
databaseName String: Database name
tableName String: Table name
tempDirectory Property Map

DatasetDatabaseInputDefinition

GlueConnectionName string: Glue connection name
DatabaseTableName string: Database table name
QueryString string: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
TempDirectory Pulumi.AwsNative.DataBrew.Inputs.DatasetS3Location

GlueConnectionName string: Glue connection name
DatabaseTableName string: Database table name
QueryString string: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
TempDirectory DatasetS3Location

glueConnectionName String: Glue connection name
databaseTableName String: Database table name
queryString String: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
tempDirectory DatasetS3Location

glueConnectionName string: Glue connection name
databaseTableName string: Database table name
queryString string: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
tempDirectory DatasetS3Location

glue_connection_name str: Glue connection name
database_table_name str: 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

glueConnectionName String: Glue connection name
databaseTableName String: Database table name
queryString String: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
tempDirectory Property Map