Package software.amazon.awscdk.cfnpropertymixins.services.databrew

Interface CfnDatasetPropsMixin.DatasetParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetPropsMixin.DatasetParameterProperty.Jsii$Proxy

Enclosing class:

CfnDatasetPropsMixin

@Stability(Stable)
public static interface CfnDatasetPropsMixin.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.cfnpropertymixins.services.databrew.*;
 DatasetParameterProperty datasetParameterProperty = DatasetParameterProperty.builder()
         .createColumn(false)
         .datetimeOptions(DatetimeOptionsProperty.builder()
                 .format("format")
                 .localeCode("localeCode")
                 .timezoneOffset("timezoneOffset")
                 .build())
         .filter(FilterExpressionProperty.builder()
                 .expression("expression")
                 .valuesMap(List.of(FilterValueProperty.builder()
                         .value("value")
                         .valueReference("valueReference")
                         .build()))
                 .build())
         .name("name")
         .type("type")
         .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	CfnDatasetPropsMixin.DatasetParameterProperty.Builder	A builder for CfnDatasetPropsMixin.DatasetParameterProperty
static final class	CfnDatasetPropsMixin.DatasetParameterProperty.Jsii$Proxy	An implementation for CfnDatasetPropsMixin.DatasetParameterProperty

Method Summary

Modifier and Type	Method	Description
static CfnDatasetPropsMixin.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.
default String	getName()	The name of the parameter that is used in the dataset's Amazon S3 path.
default 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

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 CfnDatasetPropsMixin.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 CfnDatasetPropsMixin.FilterExpressionProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnDatasetPropsMixin.DatasetParameterProperty.Builder of CfnDatasetPropsMixin.DatasetParameterProperty