class Aws::GlueDataBrew::Types::DatasetParameter

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

@note When making an API call, you may pass DatasetParameter

data as a hash:

    {
      name: "PathParameterName", # required
      type: "Datetime", # required, accepts Datetime, Number, String
      datetime_options: {
        format: "DatetimeFormat", # required
        timezone_offset: "TimezoneOffset",
        locale_code: "LocaleCode",
      },
      create_column: false,
      filter: {
        expression: "Expression", # required
        values_map: { # required
          "ValueReference" => "ConditionValue",
        },
      },
    }

@!attribute [rw] name

The name of the parameter that is used in the dataset's Amazon S3
path.
@return [String]

@!attribute [rw] type

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

@!attribute [rw] datetime_options

Additional parameter options such as a format and a timezone.
Required for datetime parameters.
@return [Types::DatetimeOptions]

@!attribute [rw] create_column

Optional boolean value that defines whether the captured value of
this parameter should be used to create a new column in a dataset.
@return [Boolean]

@!attribute [rw] filter

The optional filter expression structure to apply additional
matching criteria to the parameter.
@return [Types::FilterExpression]

@see docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DatasetParameter AWS API Documentation

Constants

SENSITIVE