AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 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:

Supporting Types

DatasetCsvOptions

Delimiter string
HeaderRow bool
Delimiter string
HeaderRow bool
delimiter String
headerRow Boolean
delimiter string
headerRow boolean
delimiter String
headerRow Boolean

DatasetDataCatalogInputDefinition

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

DatasetDatetimeOptions

Format string

Date/time format of a date parameter

LocaleCode string

Locale code for a date parameter

TimezoneOffset string

Timezone offset

Format string

Date/time format of a date parameter

LocaleCode string

Locale code for a date parameter

TimezoneOffset string

Timezone offset

format String

Date/time format of a date parameter

localeCode String

Locale code for a date parameter

timezoneOffset String

Timezone offset

format string

Date/time format of a date parameter

localeCode string

Locale code for a date parameter

timezoneOffset 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

localeCode String

Locale code for a date parameter

timezoneOffset String

Timezone offset

DatasetExcelOptions

HeaderRow bool
SheetIndexes List<int>
SheetNames List<string>
headerRow Boolean
sheetIndexes List<Integer>
sheetNames List<String>
headerRow boolean
sheetIndexes number[]
sheetNames string[]
header_row bool
sheet_indexes Sequence[int]
sheet_names Sequence[str]
headerRow Boolean
sheetIndexes List<Number>
sheetNames List<String>

DatasetFilesLimit

maxFiles Integer

Maximum number of files

order DatasetFilesLimitOrder

Order

orderedBy DatasetFilesLimitOrderedBy

Ordered by

maxFiles number

Maximum number of files

order DatasetFilesLimitOrder

Order

orderedBy DatasetFilesLimitOrderedBy

Ordered by

maxFiles Number

Maximum number of files

order "ASCENDING" | "DESCENDING"

Order

orderedBy "LAST_MODIFIED_DATE"

Ordered by

DatasetFilesLimitOrder

DatasetFilesLimitOrderedBy

DatasetFilterExpression

Expression string

Filtering expression for a parameter

ValuesMap []DatasetFilterValue
expression String

Filtering expression for a parameter

valuesMap List<DatasetFilterValue>
expression string

Filtering expression for a parameter

valuesMap DatasetFilterValue[]
expression str

Filtering expression for a parameter

values_map Sequence[DatasetFilterValue]
expression String

Filtering expression for a parameter

valuesMap List<Property Map>

DatasetFilterValue

Value string
ValueReference string

Variable name

Value string
ValueReference string

Variable name

value String
valueReference String

Variable name

value string
valueReference string

Variable name

value str
value_reference str

Variable name

value String
valueReference String

Variable name

DatasetFormat

DatasetFormatOptions

DatasetInput

DatasetJsonOptions

multiLine Boolean
multiLine boolean
multiLine Boolean

DatasetMetadata

SourceArn string

Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.

SourceArn string

Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.

sourceArn String

Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.

sourceArn 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.

sourceArn String

Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.

DatasetParameter

Name string
Type DatasetParameterType

Parameter type

CreateColumn bool

Add the value of this parameter as a column in a dataset.

DatetimeOptions DatasetDatetimeOptions
Filter DatasetFilterExpression
name String
type DatasetParameterType

Parameter type

createColumn Boolean

Add the value of this parameter as a column in a dataset.

datetimeOptions DatasetDatetimeOptions
filter DatasetFilterExpression
name string
type DatasetParameterType

Parameter type

createColumn boolean

Add the value of this parameter as a column in a dataset.

datetimeOptions DatasetDatetimeOptions
filter DatasetFilterExpression
name str
type DatasetParameterType

Parameter type

create_column bool

Add the value of this parameter as a column in a dataset.

datetime_options DatasetDatetimeOptions
filter DatasetFilterExpression
name String
type "String" | "Number" | "Datetime"

Parameter type

createColumn Boolean

Add the value of this parameter as a column in a dataset.

datetimeOptions Property Map
filter Property Map

DatasetParameterType

DatasetPathOptions

DatasetPathParameter

DatasetS3Location

Bucket string
Key string
Bucket string
Key string
bucket String
key String
bucket string
key string
bucket str
key str
bucket String
key String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0