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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataset.DatasetParameterProperty
static final class
An implementation forCfnDataset.DatasetParameterProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.default Object
Additional parameter options such as a format and a timezone.default Object
The optional filter expression structure to apply additional matching criteria to the parameter.getName()
The name of the parameter that is used in the dataset's Amazon S3 path.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
The name of the parameter that is used in the dataset's Amazon S3 path.- See Also:
-
getType
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.- See Also:
-
getCreateColumn
Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.- See Also:
-
getDatetimeOptions
Additional parameter options such as a format and a timezone.Required for datetime parameters.
- See Also:
-
getFilter
The optional filter expression structure to apply additional matching criteria to the parameter.- See Also:
-
builder
-