Package 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.118.0 (build 02eec31)", date="2025-11-04T09:27:37.751Z") @Stability(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
                                 .bucketOwner("bucketOwner")
                                 .key("key")
                                 .build())
                         .build())
                 .dataCatalogInputDefinition(DataCatalogInputDefinitionProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .tableName("tableName")
                         .tempDirectory(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .bucketOwner("bucketOwner")
                                 .key("key")
                                 .build())
                         .build())
                 .metadata(MetadataProperty.builder()
                         .sourceArn("sourceArn")
                         .build())
                 .s3InputDefinition(S3LocationProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .bucketOwner("bucketOwner")
                         .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())
         .source("source")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 String
    getSource()
    The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .
    default List<CfnTag>
    getTags()
    Metadata tags that have been applied to the dataset.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson