software.amazon.awscdk.services.databrew

Class CfnDataset

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.365Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDataset.Builder A fluent builder for CfnDataset.
static interface	CfnDataset.CsvOptionsProperty Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.
static interface	CfnDataset.DatabaseInputDefinitionProperty Connection information for dataset input files stored in a database.
static interface	CfnDataset.DataCatalogInputDefinitionProperty Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
static interface	CfnDataset.DatasetParameterProperty Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
static interface	CfnDataset.DatetimeOptionsProperty Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.
static interface	CfnDataset.ExcelOptionsProperty Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.
static interface	CfnDataset.FilesLimitProperty Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.
static interface	CfnDataset.FilterExpressionProperty Represents a structure for defining parameter conditions.
static interface	CfnDataset.FilterValueProperty Represents a single entry in the `ValuesMap` of a `FilterExpression` .
static interface	CfnDataset.FormatOptionsProperty Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
static interface	CfnDataset.InputProperty Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
static interface	CfnDataset.JsonOptionsProperty Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew .
static interface	CfnDataset.MetadataProperty Contains additional resource information needed for specific datasets.
static interface	CfnDataset.PathOptionsProperty Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.
static interface	CfnDataset.PathParameterProperty Represents a single entry in the path parameters of a dataset.
static interface	CfnDataset.S3LocationProperty Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataset(Construct scope, java.lang.String id, CfnDatasetProps props) Create a new `AWS::DataBrew::Dataset`.
protected	CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getFormat() The file format of a dataset that is created from an Amazon S3 file or folder.
java.lang.Object	getFormatOptions() A set of options that define how DataBrew interprets the data in the dataset.
java.lang.Object	getInput() Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
java.lang.String	getName() The unique name of the dataset.
java.lang.Object	getPathOptions() A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
TagManager	getTags() Metadata tags that have been applied to the dataset.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFormat(java.lang.String value) The file format of a dataset that is created from an Amazon S3 file or folder.
void	setFormatOptions(CfnDataset.FormatOptionsProperty value) A set of options that define how DataBrew interprets the data in the dataset.
void	setFormatOptions(IResolvable value) A set of options that define how DataBrew interprets the data in the dataset.
void	setInput(CfnDataset.InputProperty value) Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
void	setInput(IResolvable value) Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
void	setName(java.lang.String value) The unique name of the dataset.
void	setPathOptions(CfnDataset.PathOptionsProperty value) A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
void	setPathOptions(IResolvable value) A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataset

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

CfnDataset

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

CfnDataset

public CfnDataset(Construct scope,
                  java.lang.String id,
                  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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata tags that have been applied to the dataset.

getInput

public java.lang.Object getInput()

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

setInput

public void setInput(CfnDataset.InputProperty value)

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

setInput

public void setInput(IResolvable value)

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

getName

public java.lang.String getName()

The unique name of the dataset.

setName

public void setName(java.lang.String value)

The unique name of the dataset.

getFormat

public java.lang.String getFormat()

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

setFormat

public void setFormat(java.lang.String value)

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

getFormatOptions

public java.lang.Object getFormatOptions()

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

setFormatOptions

public void setFormatOptions(IResolvable value)

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

setFormatOptions

public void setFormatOptions(CfnDataset.FormatOptionsProperty value)

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

getPathOptions

public java.lang.Object getPathOptions()

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

setPathOptions

public void setPathOptions(IResolvable value)

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

setPathOptions

public void setPathOptions(CfnDataset.PathOptionsProperty value)

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