Package software.amazon.awscdk.services.databrew

Interface CfnDataset.DatasetParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.DatasetParameterProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.DatasetParameterProperty
extends software.amazon.jsii.JsiiSerializable

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the 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.*;
 DatasetParameterProperty datasetParameterProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataset.DatasetParameterProperty.Builder	A builder for CfnDataset.DatasetParameterProperty
static final class	CfnDataset.DatasetParameterProperty.Jsii$Proxy	An implementation for CfnDataset.DatasetParameterProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataset.DatasetParameterProperty.Builder	builder()
default Object	getCreateColumn()	Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
default Object	getDatetimeOptions()	Additional parameter options such as a format and a timezone.
default Object	getFilter()	The optional filter expression structure to apply additional matching criteria to the parameter.
String	getName()	The name of the parameter that is used in the dataset's Amazon S3 path.
String	getType()	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the parameter that is used in the dataset's Amazon S3 path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-name

getType

@Stability(Stable)
@NotNull
String getType()

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-type

getCreateColumn

@Stability(Stable)
@Nullable
default Object getCreateColumn()

Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-createcolumn

getDatetimeOptions

@Stability(Stable)
@Nullable
default Object getDatetimeOptions()

Additional parameter options such as a format and a timezone.

Required for datetime parameters.

Returns union: either IResolvable or CfnDataset.DatetimeOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-datetimeoptions

getFilter

@Stability(Stable)
@Nullable
default Object getFilter()

The optional filter expression structure to apply additional matching criteria to the parameter.

Returns union: either IResolvable or CfnDataset.FilterExpressionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-filter

builder

@Stability(Stable)
static CfnDataset.DatasetParameterProperty.Builder builder()

Returns:

a CfnDataset.DatasetParameterProperty.Builder of CfnDataset.DatasetParameterProperty