1.204.0

interface RuleProperty

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

Represents a single data quality requirement that should be validated in the scope of this 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 ruleProperty: databrew.CfnRuleset.RuleProperty = {
  checkExpression: 'checkExpression',
  name: 'name',

  // the properties below are optional
  columnSelectors: [{
    name: 'name',
    regex: 'regex',
  }],
  disabled: false,
  substitutionMap: [{
    value: 'value',
    valueReference: 'valueReference',
  }],
  threshold: {
    value: 123,

    // the properties below are optional
    type: 'type',
    unit: 'unit',
  },
};

Properties

NameTypeDescription
checkExpressionstringThe expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
namestringThe name of the rule.
columnSelectors?IResolvable | IResolvable | ColumnSelectorProperty[]List of column selectors.
disabled?boolean | IResolvableA value that specifies whether the rule is disabled.
substitutionMap?IResolvable | IResolvable | SubstitutionValueProperty[]The map of substitution variable names to their values used in a check expression.
threshold?IResolvable | ThresholdPropertyThe threshold used with a non-aggregate check expression.

checkExpression

Type: string

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.

For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .

name

Type: string

The name of the rule.

columnSelectors?

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

List of column selectors.

Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

disabled?

Type: boolean | IResolvable (optional)

A value that specifies whether the rule is disabled.

Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

substitutionMap?

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

The map of substitution variable names to their values used in a check expression.

Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".

threshold?

Type: IResolvable | ThresholdProperty (optional)

The threshold used with a non-aggregate check expression.

Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

← PreviousNext →