1.204.0

interface ProfileConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.DataBrew.CfnJob.ProfileConfigurationProperty
Javasoftware.amazon.awscdk.services.databrew.CfnJob.ProfileConfigurationProperty
Pythonaws_cdk.aws_databrew.CfnJob.ProfileConfigurationProperty
TypeScript @aws-cdk/aws-databrew » CfnJob » ProfileConfigurationProperty

Configuration for profile jobs.

Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

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 profileConfigurationProperty: databrew.CfnJob.ProfileConfigurationProperty = {
  columnStatisticsConfigurations: [{
    statistics: {
      includedStatistics: ['includedStatistics'],
      overrides: [{
        parameters: {
          parametersKey: 'parameters',
        },
        statistic: 'statistic',
      }],
    },

    // the properties below are optional
    selectors: [{
      name: 'name',
      regex: 'regex',
    }],
  }],
  datasetStatisticsConfiguration: {
    includedStatistics: ['includedStatistics'],
    overrides: [{
      parameters: {
        parametersKey: 'parameters',
      },
      statistic: 'statistic',
    }],
  },
  entityDetectorConfiguration: {
    entityTypes: ['entityTypes'],

    // the properties below are optional
    allowedStatistics: {
      statistics: ['statistics'],
    },
  },
  profileColumns: [{
    name: 'name',
    regex: 'regex',
  }],
};

Properties

NameTypeDescription
columnStatisticsConfigurations?IResolvable | IResolvable | ColumnStatisticsConfigurationProperty[]List of configurations for column evaluations.
datasetStatisticsConfiguration?IResolvable | StatisticsConfigurationPropertyConfiguration for inter-column evaluations.
entityDetectorConfiguration?IResolvable | EntityDetectorConfigurationPropertyConfiguration of entity detection for a profile job.
profileColumns?IResolvable | IResolvable | ColumnSelectorProperty[]List of column selectors.

columnStatisticsConfigurations?

Type: IResolvable | IResolvable | ColumnStatisticsConfigurationProperty[] (optional)

List of configurations for column evaluations.

ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

datasetStatisticsConfiguration?

Type: IResolvable | StatisticsConfigurationProperty (optional)

Configuration for inter-column evaluations.

Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

entityDetectorConfiguration?

Type: IResolvable | EntityDetectorConfigurationProperty (optional)

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

profileColumns?

Type: IResolvable | IResolvable | ColumnSelectorProperty[] (optional)

List of column selectors.

ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

← PreviousNext →