interface DatasetParameterProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.DataBrew.Mixins.CfnDatasetPropsMixin.DatasetParameterProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdatabrew/mixins#CfnDatasetPropsMixin_DatasetParameterProperty`
Java	`software.amazon.awscdk.mixins.preview.services.databrew.mixins.CfnDatasetPropsMixin.DatasetParameterProperty`
Python	`aws_cdk.mixins_preview.aws_databrew.mixins.CfnDatasetPropsMixin.DatasetParameterProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_databrew` » `mixins` » `CfnDatasetPropsMixin` » `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 { mixins as databrew_mixins } from '@aws-cdk/mixins-preview/aws-databrew';
const datasetParameterProperty: databrew_mixins.CfnDatasetPropsMixin.DatasetParameterProperty = {
  createColumn: false,
  datetimeOptions: {
    format: 'format',
    localeCode: 'localeCode',
    timezoneOffset: 'timezoneOffset',
  },
  filter: {
    expression: 'expression',
    valuesMap: [{
      value: 'value',
      valueReference: 'valueReference',
    }],
  },
  name: 'name',
  type: 'type',
};

Properties

Name	Type	Description
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?	`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?

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.

name?

Type: string (optional)

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

type?