software.amazon.awscdk.services.databrew

Interface CfnDataset.DatasetParameterProperty

All Known Implementing Classes:

CfnDataset.DatasetParameterProperty.Jsii$Proxy

Enclosing class:

CfnDataset

public static interface CfnDataset.DatasetParameterProperty

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataset.DatasetParameterProperty.Builder	builder()
default java.lang.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 java.lang.Object	getDatetimeOptions() Additional parameter options such as a format and a timezone.
default java.lang.Object	getFilter() The optional filter expression structure to apply additional matching criteria to the parameter.
java.lang.String	getName() The name of the parameter that is used in the dataset's Amazon S3 path.
java.lang.String	getType() The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Method Detail

getName

java.lang.String getName()

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

getType

java.lang.String getType()

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

getCreateColumn

default java.lang.Object getCreateColumn()

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

getDatetimeOptions

default java.lang.Object getDatetimeOptions()

Additional parameter options such as a format and a timezone.

Required for datetime parameters.

getFilter

default java.lang.Object getFilter()

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

builder

static CfnDataset.DatasetParameterProperty.Builder builder()

Returns:

a CfnDataset.DatasetParameterProperty.Builder of CfnDataset.DatasetParameterProperty