Package software.amazon.awscdk.services.databrew

Interface CfnJob.ProfileConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJob.ProfileConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnJob

@Stability(Stable)
public static interface CfnJob.ProfileConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.databrew.*;
 ProfileConfigurationProperty profileConfigurationProperty = ProfileConfigurationProperty.builder()
         .columnStatisticsConfigurations(List.of(ColumnStatisticsConfigurationProperty.builder()
                 .statistics(StatisticsConfigurationProperty.builder()
                         .includedStatistics(List.of("includedStatistics"))
                         .overrides(List.of(StatisticOverrideProperty.builder()
                                 .parameters(Map.of(
                                         "parametersKey", "parameters"))
                                 .statistic("statistic")
                                 .build()))
                         .build())
                 // the properties below are optional
                 .selectors(List.of(ColumnSelectorProperty.builder()
                         .name("name")
                         .regex("regex")
                         .build()))
                 .build()))
         .datasetStatisticsConfiguration(StatisticsConfigurationProperty.builder()
                 .includedStatistics(List.of("includedStatistics"))
                 .overrides(List.of(StatisticOverrideProperty.builder()
                         .parameters(Map.of(
                                 "parametersKey", "parameters"))
                         .statistic("statistic")
                         .build()))
                 .build())
         .entityDetectorConfiguration(EntityDetectorConfigurationProperty.builder()
                 .entityTypes(List.of("entityTypes"))
                 // the properties below are optional
                 .allowedStatistics(AllowedStatisticsProperty.builder()
                         .statistics(List.of("statistics"))
                         .build())
                 .build())
         .profileColumns(List.of(ColumnSelectorProperty.builder()
                 .name("name")
                 .regex("regex")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJob.ProfileConfigurationProperty.Builder	A builder for CfnJob.ProfileConfigurationProperty
static final class	CfnJob.ProfileConfigurationProperty.Jsii$Proxy	An implementation for CfnJob.ProfileConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnJob.ProfileConfigurationProperty.Builder	builder()
default Object	getColumnStatisticsConfigurations()	List of configurations for column evaluations.
default Object	getDatasetStatisticsConfiguration()	Configuration for inter-column evaluations.
default Object	getEntityDetectorConfiguration()	Configuration of entity detection for a profile job.
default Object	getProfileColumns()	List of column selectors.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumnStatisticsConfigurations

@Stability(Stable)
@Nullable
default Object getColumnStatisticsConfigurations()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-columnstatisticsconfigurations

getDatasetStatisticsConfiguration

@Stability(Stable)
@Nullable
default Object getDatasetStatisticsConfiguration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-datasetstatisticsconfiguration

getEntityDetectorConfiguration

@Stability(Stable)
@Nullable
default Object getEntityDetectorConfiguration()

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-entitydetectorconfiguration

getProfileColumns

@Stability(Stable)
@Nullable
default Object getProfileColumns()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-profilecolumns

builder

@Stability(Stable)
static CfnJob.ProfileConfigurationProperty.Builder builder()

Returns:

a CfnJob.ProfileConfigurationProperty.Builder of CfnJob.ProfileConfigurationProperty