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.58.0 (build f8ba112)",
           date="2022-05-13T01:13:27.608Z")
public class CfnDataset
extends CfnResource
implements IInspectable

A CloudFormation `AWS::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 Example:
static interface	CfnDataset.DatabaseInputDefinitionProperty Example:
static interface	CfnDataset.DataCatalogInputDefinitionProperty Example:
static interface	CfnDataset.DatasetParameterProperty Example:
static interface	CfnDataset.DatetimeOptionsProperty Example:
static interface	CfnDataset.ExcelOptionsProperty Example:
static interface	CfnDataset.FilesLimitProperty Example:
static interface	CfnDataset.FilterExpressionProperty Example:
static interface	CfnDataset.FilterValueProperty Example:
static interface	CfnDataset.FormatOptionsProperty Example:
static interface	CfnDataset.InputProperty Example:
static interface	CfnDataset.JsonOptionsProperty Example:
static interface	CfnDataset.MetadataProperty Example:
static interface	CfnDataset.PathOptionsProperty Example:
static interface	CfnDataset.PathParameterProperty Example:
static interface	CfnDataset.S3LocationProperty Example:

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() `AWS::DataBrew::Dataset.Format`.
java.lang.Object	getFormatOptions() `AWS::DataBrew::Dataset.FormatOptions`.
java.lang.Object	getInput() `AWS::DataBrew::Dataset.Input`.
java.lang.String	getName() `AWS::DataBrew::Dataset.Name`.
java.lang.Object	getPathOptions() `AWS::DataBrew::Dataset.PathOptions`.
TagManager	getTags() `AWS::DataBrew::Dataset.Tags`.
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) `AWS::DataBrew::Dataset.Format`.
void	setFormatOptions(CfnDataset.FormatOptionsProperty value) `AWS::DataBrew::Dataset.FormatOptions`.
void	setFormatOptions(IResolvable value) `AWS::DataBrew::Dataset.FormatOptions`.
void	setInput(CfnDataset.InputProperty value) `AWS::DataBrew::Dataset.Input`.
void	setInput(IResolvable value) `AWS::DataBrew::Dataset.Input`.
void	setName(java.lang.String value) `AWS::DataBrew::Dataset.Name`.
void	setPathOptions(CfnDataset.PathOptionsProperty value) `AWS::DataBrew::Dataset.PathOptions`.
void	setPathOptions(IResolvable value) `AWS::DataBrew::Dataset.PathOptions`.

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

`AWS::DataBrew::Dataset.Tags`.

getInput

public java.lang.Object getInput()

`AWS::DataBrew::Dataset.Input`.

setInput

public void setInput(CfnDataset.InputProperty value)

`AWS::DataBrew::Dataset.Input`.

setInput

public void setInput(IResolvable value)

`AWS::DataBrew::Dataset.Input`.

getName

public java.lang.String getName()

`AWS::DataBrew::Dataset.Name`.

setName

public void setName(java.lang.String value)

`AWS::DataBrew::Dataset.Name`.

getFormat

public java.lang.String getFormat()

`AWS::DataBrew::Dataset.Format`.

setFormat

public void setFormat(java.lang.String value)

`AWS::DataBrew::Dataset.Format`.

getFormatOptions

public java.lang.Object getFormatOptions()

`AWS::DataBrew::Dataset.FormatOptions`.

setFormatOptions

public void setFormatOptions(IResolvable value)

`AWS::DataBrew::Dataset.FormatOptions`.

setFormatOptions

public void setFormatOptions(CfnDataset.FormatOptionsProperty value)

`AWS::DataBrew::Dataset.FormatOptions`.

getPathOptions

public java.lang.Object getPathOptions()

`AWS::DataBrew::Dataset.PathOptions`.

setPathOptions

public void setPathOptions(IResolvable value)

`AWS::DataBrew::Dataset.PathOptions`.

setPathOptions

public void setPathOptions(CfnDataset.PathOptionsProperty value)

`AWS::DataBrew::Dataset.PathOptions`.