AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

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.AwsNative.DataBrew.DatasetFormat: Dataset format
FormatOptions Pulumi.AwsNative.DataBrew.Outputs.DatasetFormatOptions: Format options for dataset
Input Pulumi.AwsNative.DataBrew.Outputs.DatasetInput: Input
PathOptions Pulumi.AwsNative.DataBrew.Outputs.DatasetPathOptions: PathOptions

Format DatasetFormat: Dataset format
FormatOptions DatasetFormatOptions: Format options for dataset
Input DatasetInputType: Input
PathOptions DatasetPathOptions: PathOptions

format DatasetFormat: Dataset format
formatOptions DatasetFormatOptions: Format options for dataset
input DatasetInput: Input
pathOptions DatasetPathOptions: PathOptions

format DatasetFormat: Dataset format
formatOptions DatasetFormatOptions: Format options for dataset
input DatasetInput: Input
pathOptions DatasetPathOptions: PathOptions

format DatasetFormat: Dataset format
format_options DatasetFormatOptions: Format options for dataset
input DatasetInput: Input
path_options DatasetPathOptions: PathOptions

format "CSV" | "JSON" | "PARQUET" | "EXCEL" | "ORC": Dataset format
formatOptions Property Map: Format options for dataset
input Property Map: Input
pathOptions Property Map: PathOptions

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