software.amazon.awscdk.services.databrew

Interface CfnDatasetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.820Z")
 @Stability(value=Stable)
public interface CfnDatasetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDataset`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.databrew.*;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .input(InputProperty.builder()
                 .databaseInputDefinition(DatabaseInputDefinitionProperty.builder()
                         .glueConnectionName("glueConnectionName")
                         // the properties below are optional
                         .databaseTableName("databaseTableName")
                         .queryString("queryString")
                         .tempDirectory(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .key("key")
                                 .build())
                         .build())
                 .dataCatalogInputDefinition(DataCatalogInputDefinitionProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .tableName("tableName")
                         .tempDirectory(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .key("key")
                                 .build())
                         .build())
                 .metadata(MetadataProperty.builder()
                         .sourceArn("sourceArn")
                         .build())
                 .s3InputDefinition(S3LocationProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .key("key")
                         .build())
                 .build())
         .name("name")
         // the properties below are optional
         .format("format")
         .formatOptions(FormatOptionsProperty.builder()
                 .csv(CsvOptionsProperty.builder()
                         .delimiter("delimiter")
                         .headerRow(false)
                         .build())
                 .excel(ExcelOptionsProperty.builder()
                         .headerRow(false)
                         .sheetIndexes(List.of(123))
                         .sheetNames(List.of("sheetNames"))
                         .build())
                 .json(JsonOptionsProperty.builder()
                         .multiLine(false)
                         .build())
                 .build())
         .pathOptions(PathOptionsProperty.builder()
                 .filesLimit(FilesLimitProperty.builder()
                         .maxFiles(123)
                         // the properties below are optional
                         .order("order")
                         .orderedBy("orderedBy")
                         .build())
                 .lastModifiedDateCondition(FilterExpressionProperty.builder()
                         .expression("expression")
                         .valuesMap(List.of(FilterValueProperty.builder()
                                 .value("value")
                                 .valueReference("valueReference")
                                 .build()))
                         .build())
                 .parameters(List.of(PathParameterProperty.builder()
                         .datasetParameter(DatasetParameterProperty.builder()
                                 .name("name")
                                 .type("type")
                                 // the properties below are optional
                                 .createColumn(false)
                                 .datetimeOptions(DatetimeOptionsProperty.builder()
                                         .format("format")
                                         // the properties below are optional
                                         .localeCode("localeCode")
                                         .timezoneOffset("timezoneOffset")
                                         .build())
                                 .filter(FilterExpressionProperty.builder()
                                         .expression("expression")
                                         .valuesMap(List.of(FilterValueProperty.builder()
                                                 .value("value")
                                                 .valueReference("valueReference")
                                                 .build()))
                                         .build())
                                 .build())
                         .pathParameterName("pathParameterName")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDatasetProps.Builder A builder for CfnDatasetProps
static class	CfnDatasetProps.Jsii$Proxy An implementation for CfnDatasetProps

Method Summary

Modifier and Type	Method and Description
static CfnDatasetProps.Builder	builder()
default String	getFormat() The file format of a dataset that is created from an Amazon S3 file or folder.
default Object	getFormatOptions() A set of options that define how DataBrew interprets the data in the dataset.
Object	getInput() Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
String	getName() The unique name of the dataset.
default Object	getPathOptions() A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
default List<CfnTag>	getTags() Metadata tags that have been applied to the dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInput

@Stability(value=Stable)
 @NotNull
Object getInput()

Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

getName

@Stability(value=Stable)
 @NotNull
String getName()

The unique name of the dataset.

getFormat

@Stability(value=Stable)
 @Nullable
default String getFormat()

The file format of a dataset that is created from an Amazon S3 file or folder.

getFormatOptions

@Stability(value=Stable)
 @Nullable
default Object getFormatOptions()

A set of options that define how DataBrew interprets the data in the dataset.

getPathOptions

@Stability(value=Stable)
 @Nullable
default Object getPathOptions()

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

Metadata tags that have been applied to the dataset.

builder

@Stability(value=Stable)
static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps