interface DatasetParameterProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DataBrew.CfnDataset.DatasetParameterProperty`
Java	`software.amazon.awscdk.services.databrew.CfnDataset.DatasetParameterProperty`
Python	`aws_cdk.aws_databrew.CfnDataset.DatasetParameterProperty`
TypeScript	`@aws-cdk/aws-databrew` » `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 * as databrew from '@aws-cdk/aws-databrew';
const datasetParameterProperty: databrew.CfnDataset.DatasetParameterProperty = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  createColumn: false,
  datetimeOptions: {
    format: 'format',

    // the properties below are optional
    localeCode: 'localeCode',
    timezoneOffset: 'timezoneOffset',
  },
  filter: {
    expression: 'expression',
    valuesMap: [{
      value: 'value',
      valueReference: 'valueReference',
    }],
  },
};

Properties

Name	Type	Description
name	`string`	The name of the parameter that is used in the dataset's Amazon S3 path.
type	`string`	The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
createColumn?	`boolean \|` `IResolvable`	Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
datetimeOptions?	`IResolvable` `\|` `DatetimeOptionsProperty`	Additional parameter options such as a format and a timezone.
filter?	`IResolvable` `\|` `FilterExpressionProperty`	The optional filter expression structure to apply additional matching criteria to the parameter.

name

Type: string

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

type

Type: string

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

createColumn?

Type: boolean | IResolvable (optional)

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

datetimeOptions?

Type: IResolvable | DatetimeOptionsProperty (optional)

Additional parameter options such as a format and a timezone.

Required for datetime parameters.

filter?

Type: IResolvable | FilterExpressionProperty (optional)

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