Package software.amazon.awscdk.services.databrew

Class CfnDataset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.databrew.CfnDataset
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.079Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable
A CloudFormation AWS::DataBrew::Dataset.

Specifies a new DataBrew dataset.

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.*;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataset

      protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataset

      protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataset

      @Stability(Stable) public CfnDataset(@NotNull Construct scope, @NotNull String id, @NotNull CfnDatasetProps props)
      Create a new AWS::DataBrew::Dataset.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata tags that have been applied to the dataset.

    • getInput

      @Stability(Stable) @NotNull public Object getInput()
      Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

    • setInput

      @Stability(Stable) public void setInput(@NotNull CfnDataset.InputProperty value)
      Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

    • setInput

      @Stability(Stable) public void setInput(@NotNull IResolvable value)
      Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique name of the dataset.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique name of the dataset.

    • getFormat

      @Stability(Stable) @Nullable public String getFormat()
      The file format of a dataset that is created from an Amazon S3 file or folder.

    • setFormat

      @Stability(Stable) public void setFormat(@Nullable String value)
      The file format of a dataset that is created from an Amazon S3 file or folder.

    • getFormatOptions

      @Stability(Stable) @Nullable public Object getFormatOptions()
      A set of options that define how DataBrew interprets the data in the dataset.

    • setFormatOptions

      @Stability(Stable) public void setFormatOptions(@Nullable IResolvable value)
      A set of options that define how DataBrew interprets the data in the dataset.

    • setFormatOptions

      @Stability(Stable) public void setFormatOptions(@Nullable CfnDataset.FormatOptionsProperty value)
      A set of options that define how DataBrew interprets the data in the dataset.

    • getPathOptions

      @Stability(Stable) @Nullable public Object getPathOptions()
      A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

    • setPathOptions

      @Stability(Stable) public void setPathOptions(@Nullable IResolvable value)
      A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

    • setPathOptions

      @Stability(Stable) public void setPathOptions(@Nullable CfnDataset.PathOptionsProperty value)
      A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.