Package software.amazon.awscdk.services.databrew

Class CfnDataset

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.databrew.CfnDataset

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.953Z")
@Stability(Stable)
public class CfnDataset
extends CfnResource
implements IInspectable, ITaggable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataset(software.constructs.Construct scope, String id, CfnDatasetProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getFormat()	The file format of a dataset that is created from an Amazon S3 file or folder.
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.
Object	getPathOptions()	A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Metadata tags that have been applied to the dataset.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFormat(String value)	The file format of a dataset that is created from an Amazon S3 file or folder.
void	setFormatOptions(IResolvable value)	A set of options that define how DataBrew interprets the data in the dataset.
void	setFormatOptions(CfnDataset.FormatOptionsProperty value)	A set of options that define how DataBrew interprets the data in the dataset.
void	setInput(IResolvable value)	Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
void	setInput(CfnDataset.InputProperty value)	Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
void	setName(String value)	The unique name of the dataset.
void	setPathOptions(IResolvable value)	A set of options that defines how DataBrew interprets an Amazon S3 path 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	setTagsRaw(List<CfnTag> value)	Metadata tags that have been applied to the dataset.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDatasetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

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
 IResolvable 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
 CfnDataset.InputProperty 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.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Metadata tags that have been applied to the dataset.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Metadata tags that have been applied to the dataset.