interface CfnDatasetProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataBrew.CfnDatasetProps`
Java	`software.amazon.awscdk.services.databrew.CfnDatasetProps`
Python	`aws_cdk.aws_databrew.CfnDatasetProps`
TypeScript	`@aws-cdk/aws-databrew` » `CfnDatasetProps`

Properties for defining a CfnDataset.

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 cfnDatasetProps: databrew.CfnDatasetProps = {
  input: {
    databaseInputDefinition: {
      glueConnectionName: 'glueConnectionName',

      // the properties below are optional
      databaseTableName: 'databaseTableName',
      queryString: 'queryString',
      tempDirectory: {
        bucket: 'bucket',

        // the properties below are optional
        key: 'key',
      },
    },
    dataCatalogInputDefinition: {
      catalogId: 'catalogId',
      databaseName: 'databaseName',
      tableName: 'tableName',
      tempDirectory: {
        bucket: 'bucket',

        // the properties below are optional
        key: 'key',
      },
    },
    metadata: {
      sourceArn: 'sourceArn',
    },
    s3InputDefinition: {
      bucket: 'bucket',

      // the properties below are optional
      key: 'key',
    },
  },
  name: 'name',

  // the properties below are optional
  format: 'format',
  formatOptions: {
    csv: {
      delimiter: 'delimiter',
      headerRow: false,
    },
    excel: {
      headerRow: false,
      sheetIndexes: [123],
      sheetNames: ['sheetNames'],
    },
    json: {
      multiLine: false,
    },
  },
  pathOptions: {
    filesLimit: {
      maxFiles: 123,

      // the properties below are optional
      order: 'order',
      orderedBy: 'orderedBy',
    },
    lastModifiedDateCondition: {
      expression: 'expression',
      valuesMap: [{
        value: 'value',
        valueReference: 'valueReference',
      }],
    },
    parameters: [{
      datasetParameter: {
        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',
          }],
        },
      },
      pathParameterName: 'pathParameterName',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
input	`InputProperty` `\|` `IResolvable`	Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
name	`string`	The unique name of the dataset.
format?	`string`	The file format of a dataset that is created from an Amazon S3 file or folder.
formatOptions?	`IResolvable` `\|` `FormatOptionsProperty`	A set of options that define how DataBrew interprets the data in the dataset.
pathOptions?	`IResolvable` `\|` `PathOptionsProperty`	A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
tags?	`CfnTag[]`	Metadata tags that have been applied to the dataset.