Interface CfnDataset.DatasetParameterProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDataset.DatasetParameterProperty extends
Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 DatasetParameterProperty datasetParameterProperty = DatasetParameterProperty.builder()
         // the properties below are optional
                 // the properties below are optional
  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the parameter that is used in the dataset's Amazon S3 path.
    • getType

      @Stability(Stable) @NotNull String getType()
      The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    • 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.
    • getDatetimeOptions

      @Stability(Stable) @Nullable default Object getDatetimeOptions()
      Additional parameter options such as a format and a timezone.

      Required for datetime parameters.

    • getFilter

      @Stability(Stable) @Nullable default Object getFilter()
      The optional filter expression structure to apply additional matching criteria to the parameter.
    • builder

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